Interface IResource

A resource is an item referenced elsewhere with the application. This will track when a resource is no longer being used and can be removed.

interface IResource {
    isIResource: true;
    addReference(ref: any): void;
    addUnloadListener(listener: IUnloadListener): void;
    deleteReference(ref: any): void;
    getExternalURI(): Promise<string | null>;
    getFetchedFrom(): string | null;
    getName(): string | null;
    getType(): Promise<IResource.Type>;
    isClosed(): boolean;
    toBuffer(): Promise<ArrayBuffer>;
    toJSONAsync(): Promise<IResource.JSON>;
}

Hierarchy

JSONSerializableAsync<IResource.JSON>
- IResource

Implemented by

Resource

Index

Properties

Methods

addReference addUnloadListener deleteReference getExternalURI getFetchedFrom getName getType isClosed toBuffer toJSONAsync

Properties

`Readonly`isIResource

isIResource: true

For runtime type checking.

Methods

addReference

addReference(ref: any): void
Add a reference to the resource.
Parameters
- ref: any
  The object to strongly hold the resource.
Returns void

Deprecated
References are now strongly held by the resource collection.

addUnloadListener

addUnloadListener(listener: IUnloadListener): void
This does not follow the standard listener pattern and is only called once.
Parameters
- listener: IUnloadListener
  The listener to call when the resource is unloaded.
Returns void

deleteReference

deleteReference(ref: any): void
Delete a reference to the resource.
Parameters
- ref: any
  The object that held the resource.
Returns void

Deprecated
References are now strongly held by the resource collection.

getExternalURI

getExternalURI(): Promise<string | null>

Returns the resource as a uri if this is external.

Returns Promise<string | null>

getFetchedFrom

getFetchedFrom(): string | null

The URL the bytes were fetched from, when the resource is a picture the workbook keeps for it (an IMAGE source): a fetch of that URL answers from these bytes. null otherwise.

Returns string | null

getName

getName(): string | null

An optional name for the resource.

Returns string | null

getType

getType(): Promise<IResource.Type>

The mimetype of the resource.

Returns Promise<IResource.Type>

isClosed

isClosed(): boolean

true if the resource if all references have been deleted.

Returns boolean

toBuffer

toBuffer(): Promise<ArrayBuffer>

Returns the resource as a Promise to array buffer.

Returns Promise<ArrayBuffer>

toJSONAsync

toJSONAsync(): Promise<IResource.JSON>

For saving to json resources.

Returns Promise<IResource.JSON>

Overrides JSONSerializableAsync.toJSONAsync