Skip to main content

HTTPStorageConfig

HTTPStorageConfig represents the configuration that will be used if storage type is http within the client usage.
It composes of endpoint, optional index file path and credentials.

Each instance is produced automatically when creating a new rac-delta client with http storage type.


Structure

export interface HTTPStorageConfig extends BaseStorageConfig {
type: 'http';
endpoint: string;
indexFilePath?: string;
credentials?: {
bearerToken?: string;
apiKey?: string;
};
}

Properties

PropertyTypeDescription
typehttpConst string that identifies this configuration as http storage configuration.
endpointstringBase URL that will be used for all http operations.
indexFilePathstringOptional path (relative to endpoint and pathPrefix) where the remote index file can be found
credentialsObjectOptional credentials object composed of bearer token and api key