Quick Start

$ git clone https://github.com/type-express/type-express.git
$ cd type-express
$ npm install

Examples and explanations

Get Method

typeExpress.get('/users/:id', (req, res) => {
  res.send(req.params.id);
});

1. Server Side typeExpress を使用して、特定の URL パス(例: /users/2)で GET リクエストを待ち受けるようにサーバーを設定する。 この設定には、リクエストが来た際にどのようにデータを処理するか(例: ユーザー情報を取得するなど)のハンドラ関数も含まれる。

2. Client Side 特定の URL パス(例: users/2)に GET リクエストを送信。 リクエストには params や query を含むこともある。

3. Server Side: クライアントからの GET リクエストを受け取り、typeExpress のハンドラ関数が実行される。 このハンドラ関数ではリクエストボディからデータを取得し、指定された処理(例: ユーザー情報を取得するなど)を行う。 そしてその結果をレスポンスとして返す。 (Web ブラウザで特定の URL パスにアクセスした際には自動的に GET メソッドが走る)

Post Method

typeExpress.post('/auth/', (req, res) => {
  res.send(req.body);
});

1. Server Side: typeExpress を使用して、特定の URL パス(例: /data/create)で POST リクエストを待ち受けるようにサーバーを設定する。 この設定には、リクエストが来た際にどのようにデータを処理するか(例: データベースへの保存など)のハンドラ関数も含まれる。

2. Client Side: 特定の URL パス(例: /data/create)にデータを含む POST リクエストを送信

3. Server Side: クライアントからの POST リクエストを受け取り、typeExpress のハンドラ関数が実行される このハンドラ関数ではリクエストボディからデータを取得し、指定された処理(例: データベースへの保存など)を行う

Use Method

typeExpress.use((req, res, next, error) => {
  console.log('test1');
  next();
});
typeExpress.use('user/:id', (req, res, next, error) => {
  console.log(req.params.id);
});

1. use メソッドを使用すると、特定の URL パス(例: /user/:id)で指定したミドルウェアハンドラー関数が設定されます。 URL パスを指定しない場合、全ての URL パスに対して指定したミドルウェアハンドラー関数が設定されます。

2. 特定のパスにアクセスするとuseで設定されたミドルウェアハンドラー関数が実行されます。 これは、リクエストとレスポンスの間に挟まれており、ルートハンドラ(get,postなどで定義されたハンドラ)よりも前に実行されます。

   したがって、特定のパスに対してgetやpostなどでハンドラを設定すると、そのパスに対するリクエストがあったときには、 最初にuseで設定されたミドルウェアが順に実行され、その後にgetやpostなどで設定されたルートハンドラが実行されます。

   また、ミドルウェアは順番に実行され、一つのミドルウェアが完了して次に移るためにはnext()関数を呼び出す必要があります。 もしミドルウェアがnext()を呼び出さなければ、そこでリクエスト処理は停止します。

   つまり、ミドルウェアはルートハンドラに制御を移す前の処理を実行することができます。 その処理にはリクエストの検証、認証、ログ記録、エラーハンドリングなどが含まれることが多いです。