ckbox/utils

Generates an image data URL from its blurhash representation.

Parameters

hash?: string

Returns

string | undefined

Returns an extension a typical file in the specified mimeType format would have.

Parameters

mimeType: string

Returns

string

Tries to fetch the given url and returns 'content-type' of the response.

Parameters

url: string

options: object

Properties

options.signal: AbortSignal

Returns

Promise<string>

Returns an extension from the given value.

Parameters

file: File

Returns

string

Converts image source set provided by the CKBox into an object containing:

• responsive URLs for the "webp" image format,
• one fallback URL for browsers that do not support the "webp" format.

Parameters

imageUrls: CKBoxImageUrls

Returns

object

Returns a workspace id to use for communication with the CKBox service.

Parameters

token: InitializedToken

defaultWorkspaceId?: string

The default workspace to use taken from editor config.

Returns

string | null

Sends the HTTP request.

Parameters

options: object

Configuration options

Properties

options.authorization: string

The authorization token for the request.

options.data?: FormData | null

Additional data to send.

options.method?: 'POST' | 'GET'

The HTTP method (default: 'GET').

Defaults to 'GET'

options.onUploadProgress?: ( evt: ProgressEvent ) => void

A callback informing about the upload progress.

options.signal: AbortSignal

The AbortSignal to abort the request when needed.

options.url: URL

The URL where the request will be sent.

Returns

Promise<any>