Class PRN

Index

Accessors

params path ref type

Methods

param toString create parse

Accessors

params

get params(): Record<string, string>
All query-string key-value pairs, or empty object if none.

Returns Record<string, string>
- Defined in v0.10/util/prn.ts:124

path

get path(): string
The resource path segment, or empty string if absent.

Returns string
- Defined in v0.10/util/prn.ts:119

ref

get ref(): string
The resource identifier within its type — slug, UUID, name.

Returns string
- Defined in v0.10/util/prn.ts:114

type

get type(): string
The resource category — e.g. "component", "integration", "user".

Returns string
- Defined in v0.10/util/prn.ts:109

Methods

param

param(key: string): string
Returns the value for the given query-param key, or empty string if not present.
Parameters
- key: string
Returns string
- Defined in v0.10/util/prn.ts:129

toString

toString(): string
Returns string
- Defined in v0.10/util/prn.ts:133

`Static`create

create(
    type: string,
    ref: string,
    path?: string,
    params?: Record<string, string>,
): PRN
Constructs a PRN from its constituent parts. Params are sorted by key for deterministic output.
Parameters
- type: string
- ref: string
- Optionalpath: string
- Optionalparams: Record<string, string>
Returns PRN
- Defined in v0.10/util/prn.ts:67

`Static`parse

parse(s: string): PRN
Validates a PRN string and returns it as a PRN instance. Throws if the string is not a valid PRN.
Parameters
- s: string
Returns PRN
- Defined in v0.10/util/prn.ts:46