Interface ShareEncodeOptions

interface ShareEncodeOptions {
    base?: string;
    checksumBytes?: 2 | 3 | 4;
    maxChars?: number;
}

Index

Properties

base? checksumBytes? maxChars?

Properties

`Optional`base

base?: string

the page the link opens, without a fragment; empty for just the fragment

`Optional`checksumBytes

checksumBytes?: 2 | 3 | 4

checksum bytes, 2 to 4; 3 when omitted

`Optional`maxChars

maxChars?: number

the longest link in characters, base included: 2000 by default (safe in a messaging app), up to 4093 when it stays in a browser