@lumino/coreutils

method clear

clear: () => void;

• Remove all data entries from the dataset.

method clearData

clearData: (mime: string) => void;

• Remove the data entry for the given MIME type.

  Parameter mime

  The MIME type of interest.

  #### Notes This is a no-op if there is no entry for the given MIME type.

method getData

getData: (mime: string) => any | undefined;

• Get the data value for the given MIME type.

  Parameter mime

  The MIME type of interest.

  Returns

  The value for the given MIME type, or undefined if the dataset does not contain a value for the type.

method hasData

hasData: (mime: string) => boolean;

• Test whether the dataset has an entry for the given type.

  Parameter mime

  The MIME type of interest.

  Returns

  true if the dataset contains a value for the given MIME type, false otherwise.

method setData

setData: (mime: string, data: unknown) => void;

• Set the data value for the given MIME type.

  Parameter mime

  The MIME type of interest.

  Parameter data

  The data value for the given MIME type.

  #### Notes This will overwrite any previous entry for the MIME type.

method types

types: () => string[];

• Get an array of the MIME types contained within the dataset.

  Returns

  A new array of the MIME types, in order of insertion.

constructor

constructor();

• Construct a new promise delegate.

property promise

readonly promise: Promise<T>;

• The promise wrapped by the delegate.

method reject

reject: (reason: unknown) => void;

• Reject the wrapped promise with the given value.

  - The reason for rejecting the promise.

method resolve

resolve: (value: T | PromiseLike<T>) => void;

• Resolve the wrapped promise with the given value.

  Parameter value

  The value to use for resolving the promise.

constructor

constructor(name: string, description?: string);

• Construct a new token.

  Parameter name

  A human readable name for the token.

  Parameter description

  Token purpose description for documentation.

property description

readonly description?: string;

• Token purpose description.

property name

readonly name: string;

• The human readable name for the token.

  #### Notes This can be useful for debugging and logging.

index signature

[key: string]: JSONValue;

index signature

[key: string]: PartialJSONValue | undefined;

index signature

readonly [key: string]: ReadonlyJSONValue;

index signature

readonly [key: string]: ReadonlyPartialJSONValue | undefined;

variable emptyArray

const emptyArray: ReadonlyJSONArray;

• A shared frozen empty JSONArray

variable emptyObject

const emptyObject: ReadonlyJSONObject;

• A shared frozen empty JSONObject

function deepCopy

deepCopy: <T extends ReadonlyPartialJSONValue>(value: T) => T;

• Create a deep copy of a JSON value.

  Parameter value

  The JSON value to copy.

  Returns

  A deep copy of the given JSON value.

function deepEqual

deepEqual: (
    first: ReadonlyPartialJSONValue,
    second: ReadonlyPartialJSONValue
) => boolean;

• Compare two JSON values for deep equality.

  Parameter first

  The first JSON value of interest.

  Parameter second

  The second JSON value of interest.

  Returns

  true if the values are equivalent, false otherwise.

function isArray

isArray: {
    (value: JSONValue): value is JSONArray;
    (value: ReadonlyJSONValue): value is ReadonlyJSONArray;
    (value: PartialJSONValue): value is PartialJSONArray;
    (value: ReadonlyPartialJSONValue): value is ReadonlyPartialJSONArray;
};

• Test whether a JSON value is an array.

  Parameter value

  The JSON value of interest.

  Returns

  true if the value is a an array, false otherwise.

function isObject

isObject: {
    (value: JSONValue): value is JSONObject;
    (value: ReadonlyJSONValue): value is ReadonlyJSONObject;
    (value: PartialJSONValue): value is PartialJSONObject;
    (value: ReadonlyPartialJSONValue): value is ReadonlyPartialJSONObject;
};

• Test whether a JSON value is an object.

  Parameter value

  The JSON value of interest.

  Returns

  true if the value is a an object, false otherwise.

function isPrimitive

isPrimitive: (value: ReadonlyPartialJSONValue) => value is JSONPrimitive;

• Test whether a JSON value is a primitive.

  Parameter value

  The JSON value of interest.

  Returns

  true if the value is a primitive,false otherwise.

variable getRandomValues

const getRandomValues: (buffer: Uint8Array) => void;

• A function which generates random bytes.

  Parameter buffer

  The Uint8Array to fill with random bytes.

  #### Notes A cryptographically strong random number generator will be used if available. Otherwise, Math.random will be used as a fallback for randomness.

  The following RNGs are supported, listed in order of precedence: - window.crypto.getRandomValues - window.msCrypto.getRandomValues - `require('crypto').randomFillSync - `require('crypto').randomBytes - Math.random

function uuid4

uuid4: () => string;

• A function which generates UUID v4 identifiers.

  Returns

  A new UUID v4 string.

  #### Notes This implementation complies with RFC 4122.

  This uses Random.getRandomValues() for random bytes, which in turn will use the underlying crypto module of the platform if it is available. The fallback for randomness is Math.random.