Class DefaultGuardRepository

Hierarchy

DefaultGuardRepository

Implements

GuardRepository

Index

Constructors

Properties

Methods

add all forProgram get

Constructors

constructor

new DefaultGuardRepository(): DefaultGuardRepository
Returns DefaultGuardRepository

Properties

`Protected` `Readonly` manifests

manifests: Map<string, AnyGuardManifest> = ...

Methods

add

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

all

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

Returns AnyGuardManifest[]
Implementation of GuardRepository.all
- Defined in src/guards/guardRepository.ts:51

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[]
Implementation of GuardRepository.forProgram
- Defined in src/guards/guardRepository.ts:55

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
Implementation of GuardRepository.get
- Defined in src/guards/guardRepository.ts:43

Generated using TypeDoc