Interface GuardRepository

Hierarchy

GuardRepository

Implemented by

DefaultGuardRepository

Index

Methods

add all forProgram get

Methods

add

add(...manifests: AnyGuardManifest[]): void
Registers one or many guards by providing their manifest.
Parameters
- Rest ...manifests: AnyGuardManifest[]
Returns void
- Defined in src/guards/guardRepository.ts:13

all

all(): AnyGuardManifest[]
Gets all registered guard manifests.

Returns AnyGuardManifest[]
- Defined in src/guards/guardRepository.ts:19

forProgram

forProgram(program: CandyGuardProgram): AnyGuardManifest[]
Gets all guard manifests for a registered Candy Guard program.

It fails if the manifest of any guard expected by the program is not registered. Manifests are returned in the order in which they are defined on the availableGuards property of the program.
Parameters
- program: CandyGuardProgram
Returns AnyGuardManifest[]
- Defined in src/guards/guardRepository.ts:28

get

get<T>(name: string): T
Gets the manifest of a guard using its name.
Type Parameters
- T extends AnyGuardManifest = AnyGuardManifest
Parameters
- name: string
Returns T
- Defined in src/guards/guardRepository.ts:16

Generated using TypeDoc