Interface BridgeRegistry

The registry the shell holds.

interface BridgeRegistry {
    forScheme(scheme: string): Bridge | undefined;
    list(): readonly Bridge[];
    register(bridge: Bridge): void;
    resolve(uri: string, context: BridgeContext): Promise<BridgeResult>;
}

Index

Methods

forScheme list register resolve

Methods

forScheme

forScheme(scheme: string): Bridge | undefined
The bridge that serves a scheme, or undefined.
Parameters
- scheme: string
Returns Bridge | undefined

list

list(): readonly Bridge[]

Returns readonly Bridge[]

register

register(bridge: Bridge): void
Parameters
- bridge: Bridge
Returns void

resolve

resolve(uri: string, context: BridgeContext): Promise<BridgeResult>
Parse, route, authorise and resolve. Rejects with denied:, unavailable: or invalid: reasons.
Parameters
- uri: string
- context: BridgeContext
Returns Promise<BridgeResult>