Utility library for composing compound identifiers that survive url-encoding

Note components of compound identifiers are lowercase.

• cleanComponent
• decodeComponent
• encodeComponent
• isCompoundId
• makeCompoundId
• parseCompoundId
• parseUri
• undefinedIfError

▸ cleanComponent(component: string): string

Defined in index.ts:68

Clean a component for use (lower-case)

Parameters:

Returns: string

▸ decodeComponent(component: string): string

Defined in index.ts:61

Decode a component previously wrapped by encodeCOmponent (and should be the same if it was not encoded previously)

Parameters:

Returns: string

▸ encodeComponent(component: string): string

Defined in index.ts:53

Encode a component in an un-wrappable way

Parameters:

Returns: string

▸ isCompoundId(id: string): boolean

Defined in index.ts:38

Determine whether the string is a compound id

Parameters:

Returns: boolean

▸ makeCompoundId(primaryId: string, secondaryId: string): string

Defined in index.ts:46

Create a compound ID from two other ids

Parameters:

Returns: string

▸ parseCompoundId(id: string): string[]

Defined in index.ts:25

Parse a compound id (e.g. url-encoded and joined with slashses) into its constituent components

Parameters:

Returns: string[]

▸ parseUri(uri: string): string[]

Defined in index.ts:75

Parse a URI into scheme and host components for uri-ization

Parameters:

Returns: string[]

▸ undefinedIfError‹T›(fnc: function, defaultValue: T | undefined): Promise‹T | undefined›

Defined in index.ts:10

Check a function and return the defaultValue in the event it returns an error (rather than throwing)

Type parameters:

▪ T

Type of expected return

Parameters:

▪ fnc: function

Asynchronous (promise-returning) function

▸ (): Promise‹T›

▪Default value defaultValue: T | undefined= undefined

Value to return in the event of an error

Returns: Promise‹T | undefined›