_configuration_.configuration.md

@directus/sdk-js

Globals / "Configuration" / Configuration /

Class: Configuration

Configuration holder for directus implementations

author Jan Biasi biasijan@gmail.com

Hierarchy

• Configuration

Implements

• IConfiguration

Index

Constructors

• constructor

Properties

• internalConfiguration
• storage

Accessors

• localExp
• mode
• persist
• project
• token
• tokenExpirationTime
• url

Methods

• dehydrate
• dehydratedInitialConfiguration
• deleteHydratedConfig
• hydrate
• partialUpdate
• reset
• update

Object literals

• defaults

Constructors

constructor

+ new Configuration(initialConfig: IConfigurationOptions, storage?: IStorageAPI): Configuration

Defined in Configuration.ts:99

Creates a new configuration instance, will be used once for each directus instance (passing refs).

constructor

Parameters:

Name	Type	Default	Description
initialConfig	IConfigurationOptions	{} as any	Initial configuration values
storage?	IStorageAPI	-	Storage adapter for persistence

Returns: Configuration

Properties

Private internalConfiguration

• internalConfiguration: IConfigurationValues

Defined in Configuration.ts:99

Saves the internal configuration values, DO NOT modify from the outside

---

Private Optional storage

• storage? : IStorageAPI

Defined in Configuration.ts:107

Storage adapter for persistence

Accessors

localExp

• get localExp(): number | undefined

Defined in Configuration.ts:172

Returns: number | undefined

• set localExp(localExp: number | undefined): void

Defined in Configuration.ts:176

Parameters:

Name	Type
localExp	number | undefined

Returns: void

---

mode

• get mode(): AuthModes

Defined in Configuration.ts:188

Returns: AuthModes

• set mode(mode: AuthModes): void

Defined in Configuration.ts:192

Parameters:

Name	Type
mode	AuthModes

Returns: void

---

persist

• get persist(): boolean

Defined in Configuration.ts:180

Returns: boolean

• set persist(persist: boolean): void

Defined in Configuration.ts:184

Parameters:

Name	Type
persist	boolean

Returns: void

---

project

• get project(): string

Defined in Configuration.ts:162

Returns: string

• set project(project: string): void

Defined in Configuration.ts:166

Parameters:

Name	Type
project	string

Returns: void

---

token

• get token(): string | undefined

Defined in Configuration.ts:135

Returns: string | undefined

• set token(token: string): void

Defined in Configuration.ts:139

Parameters:

Name	Type
token	string

Returns: void

---

tokenExpirationTime

• get tokenExpirationTime(): number | undefined

Defined in Configuration.ts:143

Returns: number | undefined

• set tokenExpirationTime(tokenExpirationTime: number): void

Defined in Configuration.ts:147

Parameters:

Name	Type
tokenExpirationTime	number

Returns: void

---

url

• get url(): string

Defined in Configuration.ts:154

Returns: string

• set url(url: string): void

Defined in Configuration.ts:158

Parameters:

Name	Type
url	string

Returns: void

Methods

dehydrate

▸ dehydrate(): IConfigurationValues | undefined

Implementation of IConfiguration

Defined in Configuration.ts:235

Returns: IConfigurationValues | undefined

---

Private dehydratedInitialConfiguration

▸ dehydratedInitialConfiguration(storage: IStorageAPI): IConfigurationValues

Defined in Configuration.ts:268

Parameters:

Name	Type
storage	IStorageAPI

Returns: IConfigurationValues

---

deleteHydratedConfig

▸ deleteHydratedConfig(): void

Implementation of IConfiguration

Defined in Configuration.ts:260

Returns: void

---

hydrate

▸ hydrate(props: IConfigurationValues): void

Implementation of IConfiguration

Defined in Configuration.ts:252

Parameters:

Name	Type
props	IConfigurationValues

Returns: void

---

partialUpdate

▸ partialUpdate(config: Partial<IConfigurationValues>): void

Implementation of IConfiguration

Defined in Configuration.ts:212

Update partials of the configuration, behaves like the [update] method

Parameters:

Name	Type	Description
config	Partial<IConfigurationValues>

Returns: void

---

reset

▸ reset(): void

Implementation of IConfiguration

Defined in Configuration.ts:224

Reset the whole confiugration and remove hydrated values from storage as well

Returns: void

---

update

▸ update(config: IConfigurationValues): void

Implementation of IConfiguration

Defined in Configuration.ts:202

Update the configuration values, will also hydrate them if persistance activated

Parameters:

Name	Type	Description
config	IConfigurationValues

Returns: void

Object literals

Static defaults

▪ defaults: object

Defined in Configuration.ts:90

Defaults for all directus sdk instances, can be modified if preferred

type {IConfigurationDefaults}

mode

• mode: "jwt" = "jwt"

Defined in Configuration.ts:92

tokenExpirationTime

• tokenExpirationTime: number = 5 * 6 * 1000

Defined in Configuration.ts:91