Variable PathToRegexpUtilConst

Type declaration

• compile: (<P>(str: string, options?: ParseOptions & TokensToFunctionOptions) => PathFunction<P>)

  • • <P>(str: string, options?: ParseOptions & TokensToFunctionOptions): PathFunction<P>

    • Compile a string to a template function for the path.

      Type Parameters

      • P extends object = object

      Parameters

      • str: string

      • Optional options: ParseOptions & TokensToFunctionOptions

      Returns PathFunction<P>

• match: (<P>(str: Path, options?: ParseOptions & TokensToRegexpOptions & RegexpToFunctionOptions) => MatchFunction<P>)

  • • <P>(str: Path, options?: ParseOptions & TokensToRegexpOptions & RegexpToFunctionOptions): MatchFunction<P>

    • Create path match function from path-to-regexp spec.

      Type Parameters

      • P extends object = object

      Parameters

      • str: Path

      • Optional options: ParseOptions & TokensToRegexpOptions & RegexpToFunctionOptions

      Returns MatchFunction<P>

• parse: ((str: string, options?: ParseOptions) => Token[])

  • • (str: string, options?: ParseOptions): Token[]

    • Parse a string for the raw tokens.

      Parameters

      • str: string

      • options: ParseOptions = {}

      Returns Token[]

• toRegexp: ((path: Path, keys?: Key[], options?: TokensToRegexpOptions & ParseOptions) => RegExp)

  • • (path: Path, keys?: Key[], options?: TokensToRegexpOptions & ParseOptions): RegExp

    • Normalize the given path string, returning a regular expression.

      An empty array can be passed in for the keys, which will hold the placeholder key descriptions. For example, using /user/:id, keys will contain [{ name: 'id', delimiter: '/', optional: false, repeat: false }].

      Parameters

      • path: Path

      • Optional keys: Key[]

      • Optional options: TokensToRegexpOptions & ParseOptions

      Returns RegExp