Interface ISharedResource

A shared resource is a resource that can be shared between multiple objects. This will track when a resource is no longer being used and can be removed.

interface ISharedResource {
    isClosed: boolean;
    isISharedResource: true;
    name: string;
    addReference(ref): void;
    addUnloadListener(listener): void;
    deleteReference(ref): void;
    getMimeType(): Promise<string>;
    toBuffer(): Promise<ArrayBuffer>;
    toJSON(): Promise<SharedResourceJSON>;
}

Hierarchy (view full)

Properties

isClosed isISharedResource name

Methods

addReference addUnloadListener deleteReference getMimeType toBuffer toJSON

Properties

Readonly isClosed

isClosed: boolean

true if the resource if all references have been deleted.

Readonly isISharedResource

isISharedResource: true

For runtime introspection.

Readonly name

name: string

The options name of the resource

Methods

addReference

  • addReference(ref): void

  • Add a reference to the resource.

    Parameters

    • ref: any

    Returns void

addUnloadListener

  • addUnloadListener(listener): void

  • This is only called once.

    Parameters

    • listener: SharedResourceListener

    Returns void

deleteReference

  • deleteReference(ref): void

  • Delete a reference to the resource.

    Parameters

    • ref: any

    Returns void

getMimeType

  • getMimeType(): Promise<string>

  • The mimetype of the resource

    Returns Promise<string>

toBuffer

  • toBuffer(): Promise<ArrayBuffer>

  • Return the resource as a Promise to array buffer

    Returns Promise<ArrayBuffer>

toJSON

Settings

Member Visibility

Theme

On This Page

isClosedisISharedResourcenameaddReferenceaddUnloadListenerdeleteReferencegetMimeTypetoBuffertoJSON