Thanks to visit codestin.com
Credit goes to www.jsdocs.io

Logo for jsDocs.io

unrouting

  • Version 0.0.1
  • Published
  • 11.1 kB
  • 2 dependencies
  • MIT license

Install

npm i unrouting
yarn add unrouting
pnpm add unrouting

Overview

[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![bundle][bundle-src]][bundle-href] [![Codecov][codecov-src]][codecov-href] [![License][license-src]][license-href] [![JSDocs][jsdocs-src]][jsdo

Index

Functions

Interfaces

Type Aliases

Functions

function parsePath

parsePath: (filePath: string, options?: ParsePathOptions) => ParsedPath;

    function toRadix3

    toRadix3: (filePath: string | ParsedPath) => string;

    • TODO: need to implement protection logging + fall back to what radix3 supports.

    function toRegExp

    toRegExp: (filePath: string | ParsedPath) => RegExp;

      function toVueRouter4

      toVueRouter4: (filePath: string | ParsedPath) => { path: string };

        Interfaces

        interface ParsedPathSegmentToken

        interface ParsedPathSegmentToken {}

          property type

          type: SegmentType;

            property value

            value: string;

              interface ParsePathOptions

              interface ParsePathOptions {}

              • File system formats supported - vue-router/nuxt 3 styles - nitro style routes - Next.js style - sveltekit style - solid start style

              property extensions

              extensions?: string[];

              • By default the extension of the file is stripped. To disable this behaviour, pass an array of extensions to strip. The rest will be preserved.

              property postfix

              postfix?: string;

                Type Aliases

                type ParsedPath

                type ParsedPath = ParsedPathSegment[];

                  type ParsedPathSegment

                  type ParsedPathSegment = Array<ParsedPathSegmentToken>;

                    type SegmentType

                    type SegmentType = 'static' | 'dynamic' | 'optional' | 'catchall';

                      Package Files (1)

                      Dependencies (2)

                      Dev Dependencies (13)

                      Peer Dependencies (0)

                      No peer dependencies.

                      Badge

                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/unrouting.

                      • Markdown
                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/unrouting)
                      • HTML
                        <a href="https://www.jsdocs.io/package/unrouting"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>