Class FileAccountInfo

Node-only AccountInfo backend that persists the authorization response to a JSON file. Upload URL pools remain in memory because URLs are short-lived and shouldn't be shared across processes. The JSON file contains a live B2 authorization token, so treat it as sensitive and keep it out of shared or world-readable locations. FileAccountInfo serializes writes within one process but does not provide inter-process locking. If multiple processes share one path, use FileAccountInfoOptions.onDiscard and FileAccountInfoOptions.onWriteError to observe cache churn, or prefer one cache path per resolved realm and key.

On instantiation, call FileAccountInfo.load to populate state from disk (or start fresh if the file is missing or corrupt). The authorization response is written back to disk on every setAuth or clear call so a process restart can resume without re-authorizing. Cache files without an SDK metadata application-key binding are ignored once bound to a B2Client, because the SDK cannot verify which key wrote them.

This module imports node:fs/promises; do not load it in browser bundles.

Implements

Constructors

constructor

new FileAccountInfo(
path: string,
options?: FileAccountInfoOptions,
): FileAccountInfo
Constructs a FileAccountInfo bound to a JSON file on disk. The file is created on the first setAuth write; reading it back happens via load.
Parameters
- path: string
  Absolute path to the JSON file that backs this account info.
- options: FileAccountInfoOptions = {}
  Optional discard and write-error observers.
Returns FileAccountInfo
- Defined in auth/file.ts:212

Properties

`Readonly`path

path: string

Absolute path to the JSON file that backs this account info.

Methods

checkoutPartUploadUrl

checkoutPartUploadUrl(fileId: string): UploadUrlEntry | null
Takes a large-file part upload URL from the in-memory pool.
Parameters
- fileId: string
  Large file to check out a part upload URL for.
Returns UploadUrlEntry | null
A reusable part upload URL entry, or null if none are pooled.
Implementation of AccountInfo.checkoutPartUploadUrl
- Defined in auth/file.ts:503

checkoutUploadUrl

checkoutUploadUrl(bucketId: BucketId): UploadUrlEntry | null
Takes an upload URL from the in-memory pool for the given bucket.
Parameters
- bucketId: BucketId
  Bucket to check out an upload URL for.
Returns UploadUrlEntry | null
A reusable upload URL entry, or null if none are pooled.
Implementation of AccountInfo.checkoutUploadUrl
- Defined in auth/file.ts:472

clear

clear(): void
Discards in-memory state and clears the on-disk file.

Returns void
Implementation of AccountInfo.clear
- Defined in auth/file.ts:377

evictPartUploadUrl

evictPartUploadUrl(fileId: string, entry: UploadUrlEntry): void
Removes a part upload URL from the pool after an error.
Parameters
- fileId: string
  Large file the failed part upload URL belongs to.
- entry: UploadUrlEntry
  Part upload URL entry to evict.
Returns void
Implementation of AccountInfo.evictPartUploadUrl
- Defined in auth/file.ts:523

evictUploadUrl

evictUploadUrl(bucketId: BucketId, entry: UploadUrlEntry): void
Removes an upload URL from the pool after an upload error.
Parameters
- bucketId: BucketId
  Bucket the failed upload URL belongs to.
- entry: UploadUrlEntry
  Upload URL entry to evict.
Returns void
Implementation of AccountInfo.evictUploadUrl
- Defined in auth/file.ts:492

flushed

flushed(): Promise<void>
Awaits any pending disk writes. Call before process exit to ensure the latest state is persisted.

Returns Promise<void>
A promise that resolves once all queued writes are flushed.
- Defined in auth/file.ts:533

getAbsoluteMinimumPartSize

getAbsoluteMinimumPartSize(): number
Returns the server-enforced minimum part size for multipart uploads.

Returns number
The absolute minimum part size in bytes.
Implementation of AccountInfo.getAbsoluteMinimumPartSize
- Defined in auth/file.ts:434

getAccountId

getAccountId(): string
Returns the cached account identifier.

Returns string
The authorized account ID.
Implementation of AccountInfo.getAccountId
- Defined in auth/file.ts:416

getAllowedBucketId

getAllowedBucketId(): BucketId | null
Returns the bucket the key is restricted to, if any.

Returns BucketId | null
The restricted bucket ID, or null if the key is unrestricted.
Implementation of AccountInfo.getAllowedBucketId
- Defined in auth/file.ts:452

getAllowedBucketIds

getAllowedBucketIds(): readonly BucketId[] | null
Returns the buckets the key is restricted to, if any.

Returns readonly BucketId[] | null
The restricted bucket IDs, or null if the key is unrestricted.
Implementation of AccountInfo.getAllowedBucketIds
- Defined in auth/file.ts:461

getApiUrl

getApiUrl(): string
Returns the cached B2 API URL.

Returns string
The base URL for B2 API calls.
Implementation of AccountInfo.getApiUrl
- Defined in auth/file.ts:389

getAuth

getAuth(): AuthorizeAccountResponse | null
Returns the currently cached authorization response, or null if none.

Returns AuthorizeAccountResponse | null
The cached authorization response, or null if not authorized.
Implementation of AccountInfo.getAuth
- Defined in auth/file.ts:372

getAuthToken

getAuthToken(): string
Returns the cached session authorization token.

Returns string
The current authorization token.
Implementation of AccountInfo.getAuthToken
- Defined in auth/file.ts:407

getDownloadUrl

getDownloadUrl(): string
Returns the cached file-download URL.

Returns string
The base URL for file downloads.
Implementation of AccountInfo.getDownloadUrl
- Defined in auth/file.ts:398

getRecommendedPartSize

getRecommendedPartSize(): number
Returns the server-recommended part size for multipart uploads.

Returns number
The recommended part size in bytes.
Implementation of AccountInfo.getRecommendedPartSize
- Defined in auth/file.ts:425

getS3ApiUrl

getS3ApiUrl(): string
Returns the cached S3-compatible API URL.

Returns string
The base URL for the S3-compatible API.
Implementation of AccountInfo.getS3ApiUrl
- Defined in auth/file.ts:443

load

load(): Promise<void>
Reads the JSON file at the configured path and populates in-memory state. If the file is missing or contains invalid JSON, leaves state empty and returns silently (a re-auth is expected next).

Returns Promise<void>
A promise that resolves when load is complete.
- Defined in auth/file.ts:224

returnPartUploadUrl

returnPartUploadUrl(fileId: string, entry: UploadUrlEntry): void
Returns a still-valid part upload URL to the pool for reuse.
Parameters
- fileId: string
  Large file the part upload URL belongs to.
- entry: UploadUrlEntry
  Part upload URL entry to return.
Returns void
Implementation of AccountInfo.returnPartUploadUrl
- Defined in auth/file.ts:513

returnUploadUrl

returnUploadUrl(bucketId: BucketId, entry: UploadUrlEntry): void
Returns a still-valid upload URL to the pool for reuse.
Parameters
- bucketId: BucketId
  Bucket the upload URL belongs to.
- entry: UploadUrlEntry
  Upload URL entry to return.
Returns void
Implementation of AccountInfo.returnUploadUrl
- Defined in auth/file.ts:482

setApplicationKeyId

setApplicationKeyId(applicationKeyId: string): void
Binds this cache to the configured application key ID. B2Client calls this when a FileAccountInfo instance is supplied, so stale auth produced by another key is discarded before it can be used.
Parameters
- applicationKeyId: string
  Application key ID configured on the client.
Returns void
Implementation of AuthContextAwareAccountInfo.setApplicationKeyId
- Defined in auth/file.ts:257

setAuth

setAuth(auth: AuthorizeAccountResponse): void
Stores the given authorization response and triggers an async write to disk.
Parameters
- auth: AuthorizeAccountResponse
  The authorize-account response to persist.
Returns void
Implementation of AccountInfo.setAuth
- Defined in auth/file.ts:360

setRealmUrl

setRealmUrl(realmUrl: string): void
Binds this cache to the configured realm URL. B2Client calls this when a FileAccountInfo instance is supplied, so stale auth produced by another realm is discarded before it can be used.
Parameters
- realmUrl: string
  Resolved authorize-account realm URL for the client.
Returns void
Implementation of AuthContextAwareAccountInfo.setRealmUrl
- Defined in auth/file.ts:245

Class FileAccountInfo

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FileAccountInfo

Properties

Readonlypath

Methods

checkoutPartUploadUrl

Parameters

Returns UploadUrlEntry | null

checkoutUploadUrl

Parameters

Returns UploadUrlEntry | null

clear

Returns void

evictPartUploadUrl

Parameters

Returns void

evictUploadUrl

Parameters

Returns void

flushed

Returns Promise<void>

getAbsoluteMinimumPartSize

Returns number

getAccountId

Returns string

getAllowedBucketId

Returns BucketId | null

getAllowedBucketIds

Returns readonly BucketId[] | null

getApiUrl

Returns string

getAuth

Returns AuthorizeAccountResponse | null

getAuthToken

Returns string

getDownloadUrl

Returns string

getRecommendedPartSize

Returns number

getS3ApiUrl

Returns string

load

Returns Promise<void>

returnPartUploadUrl

Parameters

Returns void

returnUploadUrl

Parameters

Returns void

setApplicationKeyId

Parameters

Returns void

setAuth

Parameters

Returns void

setRealmUrl

Parameters

Returns void

Settings

On This Page

`Readonly`path