Class EnvHelper<EnvId, AbilityId>

Since

1.4.17

Type Parameters

EnvId extends string = string
AbilityId extends string = string

Hierarchy

EnvHelper

Index

Constructors

Properties

currentEnvConfig envConfigMap envId

Methods

addAbilityOnEnv addEnvInfo getConfigOnEnv getCurrentEnvConfig getCurrentEnvConfigSure getCurrentIsAbleTo getEnvId getEnvIsAbleTo setEnvConfig updateEnvId

Constructors

constructor

new EnvHelper<EnvId, AbilityId>(envConfig?: Record<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>> | Map<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>>, envId?: EnvId): envHelper.EnvHelper<EnvId, AbilityId>
Type Parameters
- EnvId extends string = string
- AbilityId extends string = string
Parameters
- Optional envConfig: Record<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>> | Map<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>>
- Optional envId: EnvId
Returns envHelper.EnvHelper<EnvId, AbilityId>
- Defined in src/env-helper.ts:30

Properties

`Private` currentEnvConfig

currentEnvConfig: null | envHelper.EnvOneConfig<AbilityId> = null

`Private` envConfigMap

envConfigMap: envHelper.EnvConfigMap<EnvId, AbilityId> = ...

`Private` envId

envId: string = ""

Methods

addAbilityOnEnv

addAbilityOnEnv(envId: EnvId, abilityId: AbilityId): envHelper.EnvHelper<EnvId, AbilityId>
Parameters
- envId: EnvId
- abilityId: AbilityId
Returns envHelper.EnvHelper<EnvId, AbilityId>
- Defined in src/env-helper.ts:108

addEnvInfo

addEnvInfo(envId: EnvId, envConfig?: Partial<envHelper.EnvOneConfig<AbilityId>>): envHelper.EnvHelper<EnvId, AbilityId>
Parameters
- envId: EnvId
- Optional envConfig: Partial<envHelper.EnvOneConfig<AbilityId>>
Returns envHelper.EnvHelper<EnvId, AbilityId>
- Defined in src/env-helper.ts:71

getConfigOnEnv

getConfigOnEnv(envId: EnvId): undefined | envHelper.EnvOneConfig<AbilityId>
Parameters
- envId: EnvId
Returns undefined | envHelper.EnvOneConfig<AbilityId>
- Defined in src/env-helper.ts:104

getCurrentEnvConfig

getCurrentEnvConfig(): null | envHelper.EnvOneConfig<AbilityId>
Returns null | envHelper.EnvOneConfig<AbilityId>
- Defined in src/env-helper.ts:47

getCurrentEnvConfigSure

getCurrentEnvConfigSure(): envHelper.EnvOneConfig<AbilityId>
Returns envHelper.EnvOneConfig<AbilityId>
- Defined in src/env-helper.ts:51

getCurrentIsAbleTo

getCurrentIsAbleTo(abilityId: AbilityId): boolean
Parameters
- abilityId: AbilityId
Returns boolean
- Defined in src/env-helper.ts:55

getEnvId

getEnvId(envId: string): boolean
Parameters
- envId: string
Returns boolean
- Defined in src/env-helper.ts:100

getEnvIsAbleTo

getEnvIsAbleTo(envId: EnvId, abilityId: AbilityId): boolean
Parameters
- envId: EnvId
- abilityId: AbilityId
Returns boolean
- Defined in src/env-helper.ts:63

setEnvConfig

setEnvConfig(envConfig?: Record<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>> | Map<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>>): envHelper.EnvHelper<EnvId, AbilityId>
Parameters
- Optional envConfig: Record<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>> | Map<EnvId, Partial<envHelper.EnvOneConfig<AbilityId>>>
Returns envHelper.EnvHelper<EnvId, AbilityId>
- Defined in src/env-helper.ts:86

updateEnvId

updateEnvId(envId: EnvId): void
Parameters
- envId: EnvId
Returns void
- Defined in src/env-helper.ts:42

Generated using TypeDoc