@gpa/extract-params-from-path
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

@gpa/extract-params-from-path

Gitlab Pipeline Status GitLab Issues GitLab License Node Current NPM Unpacked Size

Extract the parameters declared in an express path specification using the Typescript type system. Used to compute the list of available path parameters in a router in @gpa/type-safe-express.

The runtime path parameter parser of express is implemented in path-to-regexp, this library is compatible with:

@gpa/extract-params-from-path version express version path-to-regexp version
0.x 4.0-5.0.0-alpha.8 0.x
1.x 5.0.0-beta.1-5.0.0-beta.3 3.2.0 (through router@2.0.0-beta.1)
2.x from 5.0.0 8.x (through router@2.0.0-beta.2)

Table of Contents

  1. Installation
  2. Requirements
  3. Usage
  4. API

Installation

npm install @gpa/extract-params-from-path

Requirements

Usage

import { ExtractParamsFromPath } from '@gpa/extract-params-from-path';

function router<Path extends string>(path: Path, handler: (request: { params: ExtractParamsFromPath<Path> }) => void) {}

router('/path/:pathParam', (req) => {
  // req.params is { pathParam: string }
});

API

ExtractParamsFromPath<Path extends string>

<Path>

Type: string

The path to extract the parameters from.

Readme

Keywords

none

Package Sidebar

Install

npm i @gpa/extract-params-from-path

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

61.6 kB

Total Files

23

Last publish

Collaborators

  • gpa