Skip to main content

@rtorcato/browser-common / urlpattern

urlpattern

Functions​

isURLPatternAvailable()​

isURLPatternAvailable(): boolean

Defined in: urlpattern/index.ts:10

Checks if the URLPattern API is available in the current environment.

Example​

import { isURLPatternAvailable } from '@rtorcato/browser-common/urlpattern'
if (isURLPatternAvailable()) useNativeRouter()

Returns​

boolean

True if available, false otherwise.

createURLPattern()​

createURLPattern(input, baseURL?): URLPattern

Defined in: urlpattern/index.ts:27

Creates a URLPattern for matching URLs.

Example​

import { createURLPattern } from '@rtorcato/browser-common/urlpattern'
const pattern = createURLPattern({ pathname: '/users/:id' })
const match = pattern.exec('https://example.com/users/42')

Parameters​

input​

URLPatternInput

The pattern input (string or URLPatternInit).

baseURL?​

string

Optional base URL when input is a relative string.

Returns​

URLPattern

A URLPattern instance.

Throws​

If URLPattern is unsupported in the current environment.

matchURLPattern()​

matchURLPattern(pattern, input): URLPatternResult | null

Defined in: urlpattern/index.ts:47

Tests whether a URL matches a pattern, returning the match result or null.

Example​

import { matchURLPattern } from '@rtorcato/browser-common/urlpattern'
const result = matchURLPattern({ pathname: '/users/:id' }, 'https://example.com/users/42')
result?.pathname.groups.id // '42'

Parameters​

pattern​

URLPatternInput

The pattern input (string or URLPatternInit).

input​

string

The URL to test.

Returns​

URLPatternResult | null

The URLPatternResult if it matches, otherwise null.

Throws​

If URLPattern is unsupported in the current environment.