Skip to content

Commit 341d0e7

Browse files
committed
Add an example with Typescript and CJS
1 parent 69bf83e commit 341d0e7

File tree

5 files changed

+16
-80
lines changed

5 files changed

+16
-80
lines changed

examples/echo-bot-ts-cjs/.gitignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

examples/echo-bot-ts-cjs/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# LINE Echo Bot with TypeScript (CJS)
1+
# Echo Bot for LINE using TypeScript and CJS
22

3-
An example LINE bot to echo message with TypeScript. The bot is coded according to TypeScript's best practices.
3+
Welcome to this simple guide on how to create an Echo Bot for the LINE messaging platform using TypeScript and CommonJS (CJS).
4+
An Echo Bot is a basic bot that replies to a user's message with the same content.
5+
This tutorial will help you set up a LINE Echo Bot from scratch.
46

57
## Prerequisite
68

7-
- Git
8-
- Node.js version 10 and up
9-
- LINE Developers Account for the bot
9+
- Node.js version 18 or higher
10+
- You've created a channel in the LINE Developers Console, and got your channel access token and channel secret.
11+
- Read https://developers.line.biz/en/docs/messaging-api/getting-started/#using-console if you haven't done this yet.
1012

1113
## Installation
1214

@@ -19,7 +21,7 @@ git clone https://github.com/line/line-bot-sdk-nodejs.git
1921
- Change directory to the example.
2022

2123
```bash
22-
cd line-bot-sdk-nodejs/examples/echo-bot-ts
24+
cd line-bot-sdk-nodejs/examples/echo-bot-ts-cjs
2325
```
2426

2527
- Install all dependencies.
@@ -43,7 +45,7 @@ export PORT=<YOUR_PORT>
4345
https://example.com/callback
4446
```
4547

46-
- Compile the TypeScript files.
48+
- Build the application.
4749

4850
```bash
4951
npm run build

examples/echo-bot-ts-cjs/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ const clientConfig: ClientConfig = {
1616
};
1717

1818
const middlewareConfig: MiddlewareConfig = {
19-
channelAccessToken: process.env.CHANNEL_ACCESS_TOKEN,
2019
channelSecret: process.env.CHANNEL_SECRET || '',
2120
};
2221

examples/echo-bot-ts-cjs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "echo-bot-ts-cjs",
33
"version": "0.0.0",
4-
"description": "An example LINE bot with TypeScript made to echo messages",
4+
"description": "A LINE Messaging API SDK for Node.js bot example using TypeScript with CJS",
55
"main": "./dist/index.js",
66
"scripts": {
77
"clean": "rimraf ./dist",
Lines changed: 6 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,11 @@
11
{
22
"compilerOptions": {
3-
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4-
5-
/* Basic Options */
6-
// "incremental": true, /* Enable incremental compilation */
7-
"target": "ES2017", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
8-
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
9-
// "lib": [], /* Specify library files to be included in the compilation. */
10-
// "allowJs": true, /* Allow javascript files to be compiled. */
11-
// "checkJs": true, /* Report errors in .js files. */
12-
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
13-
// "declaration": true, /* Generates corresponding '.d.ts' file. */
14-
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
15-
// "sourceMap": true, /* Generates corresponding '.map' file. */
16-
// "outFile": "./", /* Concatenate and emit output to single file. */
17-
"outDir": "./dist", /* Redirect output structure to the directory. */
18-
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
19-
// "composite": true, /* Enable project compilation */
20-
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
21-
// "removeComments": true, /* Do not emit comments to output. */
22-
// "noEmit": true, /* Do not emit outputs. */
23-
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
24-
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
25-
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
26-
27-
/* Strict Type-Checking Options */
28-
"strict": true, /* Enable all strict type-checking options. */
29-
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30-
// "strictNullChecks": true, /* Enable strict null checks. */
31-
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
32-
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33-
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34-
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35-
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36-
37-
/* Additional Checks */
38-
// "noUnusedLocals": true, /* Report errors on unused locals. */
39-
// "noUnusedParameters": true, /* Report errors on unused parameters. */
40-
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
41-
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
42-
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
43-
44-
/* Module Resolution Options */
45-
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
46-
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
47-
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
48-
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
49-
// "typeRoots": [], /* List of folders to include type definitions from. */
50-
// "types": [], /* Type declaration files to be included in compilation. */
51-
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
52-
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
53-
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
54-
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
55-
56-
/* Source Map Options */
57-
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
58-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
59-
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
60-
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
61-
62-
/* Experimental Options */
63-
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
64-
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
65-
66-
/* Advanced Options */
67-
"skipLibCheck": true, /* Skip type checking of declaration files. */
68-
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
3+
"target": "ES2017",
4+
"module": "commonjs",
5+
"outDir": "./dist",
6+
"strict": true,
7+
"esModuleInterop": true,
8+
"forceConsistentCasingInFileNames": true
699
},
7010
"exclude": ["node_modules"]
7111
}

0 commit comments

Comments
 (0)