Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "api"

This file contains the public API of the URL Parsing and Matching library 'mimurl'.

To read about mimurl features please visit here.

To play with mimurl pattern parsing and URL matching capabilities please visit here.

Index

Type aliases

FieldBag

FieldBag: object

Object containing properties whose names are field names and values are field values.

Type declaration

FieldValueType

Field value type, which can be either singe value or multiple value type

MultiFieldValueType

MultiFieldValueType: SingleFieldValueType[]

Types of fields with multiple values

ParsedLocation

ParsedLocation: object

The ParsedLocation type defines how different section of the URL pattern can be located in the original pattern string. Location is defined using the zero-based index where the section begins and its length.

Type declaration

SingleFieldValueType

SingleFieldValueType: string | number | boolean

Supported primitive types of field values

Functions

match

parseURL

  • Parses the given URL

    Parameters

    • s: string

      URL string to be parsed.

    Returns IParsedActualURL

parseUrlPattern

  • Parses the given URL pattern

    Parameters

    • s: string

      URL pattern string to be parsed.

    Returns IParsedUrlPattern

Generated using TypeDoc