nestjs-clone-bay docs
GitHub
GitHub
  • Introduction
  • Testing
  • API Reference

Class: CloneBayConfigService

Control nestjs-clone-bay configuration during run time.

This service exposes methods for controlling dynamic configuration. The dynamic configuration is persisted over app restarts, but unlike static configuration, does not require app restart to take effect.

Changes made to dynamic configuration via this service take effect immediately.

Methods

getDynamicConfig

▸ getDynamicConfig(): Promise<DynamicConfig>

Get current dynamic configuration.

Returns

Promise<DynamicConfig>

Defined in

lib/src/api/clone-bay-config.service.ts:29


setAllowedAlliances

▸ setAllowedAlliances(allowedAlliances): Promise<void>

Set authentication allowlist of alliances.

Authentication is allowed if authenticating character is a member of an alliance included in this allowlist.

Parameters

NameTypeDescription
allowedAlliancesnumber[]EVE ID's of allowed alliances.

Returns

Promise<void>

Defined in

lib/src/api/clone-bay-config.service.ts:65


setAllowedCharacters

▸ setAllowedCharacters(allowedCharacters): Promise<void>

Set authentication allowlist of characters.

Authentication is allowed if authenticating character is included in this allowlist.

Parameters

NameTypeDescription
allowedCharactersnumber[]EVE ID's of allowed characters.

Returns

Promise<void>

Defined in

lib/src/api/clone-bay-config.service.ts:41


setAllowedCorporations

▸ setAllowedCorporations(allowedCorporations): Promise<void>

Set authentication allowlist of corporations.

Authentication is allowed if authenticating character is a member of a corporation included in this allowlist.

Parameters

NameTypeDescription
allowedCorporationsnumber[]EVE ID's of allowed corporations.

Returns

Promise<void>

Defined in

lib/src/api/clone-bay-config.service.ts:53

Edit this page
Last Updated: