Skip to main content

Function: decodeShareHash()

function decodeShareHash(hash, options?): Promise<SharePayload & object | null>;

Accepts "#…" or "…". Returns null when there is no dbml key. A dbml value that is not base64url or does not inflate is read as legacy encodeURIComponent text (phase-1 links). A layout that fails to inflate or parseLayout is dropped (layoutError says why). Throws ShareTooLargeError when the DBML (inflated, or legacy text) is larger than options.maxBytes (default MAX_SHARE_BYTES, UTF-8 bytes); a too-large layout is dropped.

Parameters​

hash​

string

options?​

maxBytes?​

number

Returns​

Promise<SharePayload & object | null>