JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 21767
  • Score
    100M100P100Q146414F
  • License MIT

TypeScript definitions for route-parser

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/route-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/route-parser

    Summary

    This package contains type definitions for route-parser (https://github.com/rcs/route-parser).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/route-parser.

    index.d.ts

    declare class Route<TParams extends {} = { [i: string]: any }> {
        /**
         * Represents a route
         * @example
         * var route = new Route('/:foo/:bar');
         * @example
         * var route = new Route('/:foo/:bar');
         */
        constructor(spec: string);
    
        /**
         * Match a path against this route, returning the matched parameters if
         * it matches, false if not.
         * @example
         * var route = new Route('/this/is/my/route')
         * route.match('/this/is/my/route') // -> {}
         * @example
         * var route = new Route('/:one/:two')
         * route.match('/foo/bar/') // -> {one: 'foo', two: 'bar'}
         */
        match(pathname: string): { [k in keyof TParams]: string } | false;
    
        /**
         * Reverse a route specification to a path, returning false if it can't be
         * fulfilled
         * @example
         * var route = new Route('/:one/:two')
         * route.reverse({one: 'foo', two: 'bar'}) -> '/foo/bar'
         */
        reverse(params: TParams): string | false;
    }
    
    declare namespace Route {}
    export = Route;
    

    Additional Details

    • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
    • Dependencies: none

    Credits

    These definitions were written by Ian Ker-Seymer, and Bob Buehler.