Class Store

Implements

IEventEmitter<StoreEvents>

Index

Constructors

Properties

_status emit name off on online requester resolver storage urlCache

Methods

add createUrl destroy getBase64 getBlob getText put request retrieve revokeUrl

Constructors

constructor

new Store(
    name: string,
    requester?: RequestFunction,
    resolver?: (href: string) => string,
): Store
Parameters
- name: string
- Optionalrequester: RequestFunction
- Optionalresolver: (href: string) => string
Returns Store
- Defined in store.ts:74

Properties

_status

_status: ((event: Event) => void) | undefined

emit

emit: <K extends string>(type: K, ...args: StoreEvents[K]) => void

name

name: string

off

off: <K extends string>(type: K, fn?: (...args: StoreEvents[K]) => void) => void

on

on: <K extends string>(type: K, fn: (...args: StoreEvents[K]) => void) => void

online

online: boolean

requester

requester: RequestFunction

resolver

resolver: (href: string) => string

storage

storage: SimpleStorage

urlCache

urlCache: Record<string, string>

Methods

add

add(
resources: { resources: { href: string }[] },
force?: boolean,
): Promise<(Uint8Array<ArrayBufferLike> | null)[]>
Add all of a book resources to the store
Parameters
- resources: { resources: { href: string }[] }
  book resources
- Optionalforce: boolean
  force resaving resources
Returns Promise<(Uint8Array<ArrayBufferLike> | null)[]>
store objects
- Defined in store.ts:143

createUrl

createUrl(url: string, options?: { base64?: boolean }): Promise<string>
Create a Url from a stored item
Parameters
- url: string
- Optionaloptions: { base64?: boolean }
  - Optionalbase64?: boolean
    use base64 encoding or blob url
Returns Promise<string>
url promise with Url string
- Defined in store.ts:358

destroy

destroy(): void
Returns void
- Defined in store.ts:418

getBase64

getBase64(url: string, mimeType?: string): Promise<string | undefined>
Get a base64 encoded result from Storage by Url
Parameters
- url: string
- OptionalmimeType: string
Returns Promise<string | undefined>
base64 encoded
- Defined in store.ts:330

getBlob

getBlob(url: string, mimeType?: string): Promise<Blob | undefined>
Get a Blob from Storage by Url
Parameters
- url: string
- OptionalmimeType: string
Returns Promise<Blob | undefined>
- Defined in store.ts:282

getText

getText(url: string, mimeType?: string): Promise<string | undefined>
Get Text from Storage by Url
Parameters
- url: string
- OptionalmimeType: string
Returns Promise<string | undefined>
- Defined in store.ts:301

put

put(
    url: string,
    withCredentials?: boolean,
    headers?: Record<string, string>,
): Promise<Uint8Array<ArrayBufferLike> | null>
Put binary data from a url to storage
Parameters
- url: string
  a url to request from storage
- OptionalwithCredentials: boolean
- Optionalheaders: Record<string, string>
Returns Promise<Uint8Array<ArrayBufferLike> | null>
- Defined in store.ts:171

request

request(
    url: string,
    type?: string,
    withCredentials?: boolean,
    headers?: Record<string, string>,
): Promise<unknown>
Request a url
Parameters
- url: string
  a url to request from storage
- Optionaltype: string
  specify the type of the returned result
- OptionalwithCredentials: boolean
- Optionalheaders: Record<string, string>
Returns Promise<unknown>
- Defined in store.ts:192

retrieve

retrieve(url: string, type?: string): Promise<unknown>
Request a url from storage
Parameters
- url: string
  a url to request from storage
- Optionaltype: string
  specify the type of the returned result
Returns Promise<unknown>
- Defined in store.ts:213

revokeUrl

revokeUrl(url: string): void
Revoke Temp Url for a archive item
Parameters
- url: string
  url of the item in the store
Returns void
- Defined in store.ts:413