FilesClientOptions

Defined in: libs/ccs-files-user-client/src/core/types.ts:782

Properties

apiUrl?

optional apiUrl?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:789

The File Service API base, e.g. https://files.centralcodestation.com/api/v1. Omitted: the production API, https://files.centralcodestation.com/api/v1 (DEFAULT_API_URL). A browser has no environment to read: for another environment pass it, or let your backend’s token route send api_url (FilesClient.fromTokenRoute).

---

tenantId

tenantId: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:790

---

applicationId

applicationId: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:791

---

getAccessToken

getAccessToken: GetAccessToken

Defined in: libs/ccs-files-user-client/src/core/types.ts:793

The user’s files-api token (files:access): tokens.getAccessToken of createTokenProvider.

---

fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: libs/ccs-files-user-client/src/core/types.ts:795

Override fetch (tests, SSR). Also the upload transport where no XMLHttpRequest exists (Node).

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

xhrFactory?

optional xhrFactory?: () => XhrLike

Defined in: libs/ccs-files-user-client/src/core/types.ts:797

Builds the XMLHttpRequest of each store PUT (upload progress events). Default new XMLHttpRequest().

Returns

XhrLike

---

concurrency?

optional concurrency?: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:799

Parts in flight per multipart upload. Default 4.

---

checksum?

optional checksum?: boolean

Defined in: libs/ccs-files-user-client/src/core/types.ts:801

Send content_sha256 (SHA-256 through Web Crypto) for files up to 256 MiB. Default false: it reads the file twice.

---

debug?

optional debug?: boolean

Defined in: libs/ccs-files-user-client/src/core/types.ts:803

Log to the console. Default false.

---

maxRetries?

optional maxRetries?: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:805

Retries of an API request after the first attempt, for 5xx and network errors on reads and idempotent writes. Default 3.

---

tokenProvider?

optional tokenProvider?: TokenProvider

Defined in: libs/ccs-files-user-client/src/core/types.ts:807

Set by fromTokenRoute: signOut() clears it.

---

routeConfig?

optional routeConfig?: TokenRouteConfig

Defined in: libs/ccs-files-user-client/src/core/types.ts:809

Set by fromTokenRoute: the route’s configuration, exposed as client.routeConfig.

---

now?

optional now?: () => number

Defined in: libs/ccs-files-user-client/src/core/types.ts:811

Clock override for tests (URL cache expiry).

Returns

number