Interface ReferenceableClipboard

Extended clipboard that allows for writing non serializable objects to the clipboard.

interface ReferenceableClipboard {
    clear(native?: boolean): void;
    readReference<T extends ReferenceableClipboard.ReferenceItem<any>>(): Promise<
        T,
    >;
    writeReference<T extends ReferenceableClipboard.ReferenceItem<any>>(
        data: T,
    ): Promise<void>;
}

Hierarchy

Clipboard
- ReferenceableClipboard

Implemented by

InternalClipboard

Index

Methods

clear readReference writeReference

Methods

clear

clear(native?: boolean): void
Simple method for clearing the clipboard.
Parameters
- Optionalnative: boolean
  By default this will only clear the reference. Set to true to clear the native clipboard items if available.
Returns void

readReference

readReference<T extends ReferenceableClipboard.ReferenceItem<any>>(): Promise<T>
Allows for an item to be added to the clipboard that is not a Blob.
Type Parameters
- T extends ReferenceableClipboard.ReferenceItem<any>
Returns Promise<T>

writeReference

writeReference<T extends ReferenceableClipboard.ReferenceItem<any>>(
data: T,
): Promise<void>
Allows for an item to be added to the clipboard that is not a serializable blob.
Type Parameters
- T extends ReferenceableClipboard.ReferenceItem<any>
Parameters
- data: T
Returns Promise<void>