Interface ApiXKeyStore

An interface for an object that securely stores API keys and application keys.

interface ApiXKeyStore {
    getApiKey(): string | Promise<string>;
    getAppKey(): string | Promise<string>;
    getKeys(): ApiXKeys | Promise<ApiXKeys>;
}

Implemented by

ApiXEncryptedKeyStore

Index

Methods

getApiKey getAppKey getKeys

Methods

getApiKey

getApiKey(): string | Promise<string>
Retrieves the API key for the given application.

Returns string | Promise<string>
- Defined in client/security/ApiXKeyStore.ts:24

getAppKey

getAppKey(): string | Promise<string>
Retrieves the application key for the given API key.

Returns string | Promise<string>
- Defined in client/security/ApiXKeyStore.ts:29

getKeys

getKeys(): ApiXKeys | Promise<ApiXKeys>
Retrieves both API and application keys as an object.

Returns ApiXKeys | Promise<ApiXKeys>
- Defined in client/security/ApiXKeyStore.ts:34