From 8dc88730b80f4c556d2bc8696478bf97b3c689e7 Mon Sep 17 00:00:00 2001 From: Erin Rivas Date: Tue, 19 Mar 2024 10:05:10 -0500 Subject: [PATCH] docs update --- docs/assets/search.js | 2 +- docs/interfaces/IBech32Handler.html | 6 ++++-- docs/interfaces/IDecoded.html | 4 ++-- docs/variables/bech32.html | 2 +- docs/variables/bech32m.html | 2 +- 5 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/assets/search.js b/docs/assets/search.js index aa193c5..78bc01b 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62WTY+bMBCG/4v3irKM+UxurXro3npqDyiqWHC0qHwJ6GarKP+9YwjYXmw2iL1Emvh95sUzg/GFNNW5JYfoQv5kZUoODrVIGReMHMgzS14cSizyt8kxfI2bLH7OWfs4LOxeuiLH1SSP25ZhDkKuljFNYcxTLCainj9levraA9/jMs1ZMyXMyo41pzjBjKpiObHthlPm9hzXPxp2yt7uzPqgEJKBReq4YWU3f9wPrb+0/8pkvf+IbXkIViZVyu71ntTbLVftWUW2mKdszX4n9XbLVftVkS3mXfWratL2XmMh/wTTVVt+x2yxPzVVsWrXMvApxqt2PqPWPoJ8UH7rJyfVet/WFg9HsKk7ZavNB6Oc66H+4DgcH8pgczb2SnE5L3doMjlamCNlb+RwIa+sabOqxHW6c3Z7BE4Zy1P+3RvcMV1VFDzF8bb2kyVd1XDFIHm0iRXZFnV3NAiORysaiX6h/6OXAUagk4Eiw89qRHUyqsgcjBydzFFkLkauTuYqMg8jTyfzFJmPka+T+YoswCjQyQJFFmIU6mShIsOmRHudbK+Wl1cbtH2Ad43oO6FvhdoL4DUHbTdAbQfwsoO2IaB2BHjlQdsTUJsCvPigbQsMfeknGUe4Y+nTMNE4k+Pl7EJ+38bcHt+kC7Hx53oVQ80jnni6igkKBAUGavz8CSgQULAIxcNZJshQkKGBHG8XAvIE5C1CMztfkL6B5Ofu7UyRqiKXxVSXiZzZApVwasCzoRsv421W4BJthNPxhJdcHcnVMYDjIS1hroS5BoxfN+eoZGjyE+CsSpKvybarZq3ZC2q/TM3bIr0iYHpH5rMgjR9o5w9f0DqrWZ6VKIqO1+t/L7demVYNAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62XS4+bMBSF/4tnizJcXoHsWnXR7LqaLlBUMWAUNLwENJkK5b/XhoDtYFMo2YzkcL577HMx9rSoKq41Ovgt+kjyCB1MQ0N5kGF0QO84PJsG0tDvKiXDS1AlwXuK69f+we7cZCl5GqZBXWNSA6GbpiyTKetks4UM2xkrHb92wPcgj1JcjQWTvMFVHISkoqiYL6xb7lg5POPw4xi/BWkSLaz78sBwJhoqgwrnzXTKC+y/1H/y8H/mMIBbJlJfg/JHhePkc+kMBOI51qsSmGJbJoHzsIjwUu9Rvd1y1ZpFZIt5hNesd1Rvt1y1XhHZYt4UP4sqqpcaM/kTTFct+YHZYh9XRbZq1TzwFONVK59Qa6fAHxjfujdH/km/P5s9JEA3rLFaqf4w8rVeyn98DodJKWyuyl4JLtf5Do0mJ43UiPAnOrTogqs6KXLy3NiZO48AcYLTiJ7/vTspV2QZLXG6P3vDYVNUVNFLXnWk+bpm2DvTO500fwC637sfOhWQEUhUIKjI5cI3JCpDUJlkZEpUpqCyyMiSqCxBZZORLVHZgsohI0eicgTVnoz2EtVeULlk5EpUrqAivfA9icoTU6Uhgyx9eIi/y1/aALEDQKMGWQ9AbALQtEHWBhD7ADRwkHUCxFYAzRxkzQCxG0BjB1k/QGwI0ORB1hLoe9LtBbIJGhwd+z1B3urhmtuiX/eNog97sUU6+XO7sW1BR7TweKllFDAKFFR3XUviS39lZKjJUHMBGvRfRsZbjLcU/HB2M8hjkDcLTeyACwhUCQ2XI4btGbWfhSaGLiNdBUmPjfsnkZsoFyyokh3J6Tq5XEEVbNK/CufhnxKGG4w2VHA0HFCcq8252gpwOGM4zOEwR4HR2/IU5QxVfgycpMT5qmybYtoafruo9sudmzaGixZU2U4tuRcQpG8g+T6USYnTJCci/3S7/QXDuXIuHw8AAA=="; \ No newline at end of file diff --git a/docs/interfaces/IBech32Handler.html b/docs/interfaces/IBech32Handler.html index 4011551..de79b19 100644 --- a/docs/interfaces/IBech32Handler.html +++ b/docs/interfaces/IBech32Handler.html @@ -1,4 +1,6 @@ -IBech32Handler | @jackallabs/bech32

Interface IBech32Handler

Hierarchy

  • IBech32Handler

Methods

decode +IBech32Handler | @jackallabs/bech32

Interface IBech32Handler

Hierarchy

  • IBech32Handler

Methods

checkIfValid +checkIfValidAsync +decode decodeAsync encode encodeAsync @@ -8,4 +10,4 @@ swapPrefixAsync toWords toWordsAsync -

Methods

decode

decodeAsync

encode

encodeAsync

  • Parameters

    • prefix: string
    • words: ArrayLike<number>
    • Optional LIMIT: number

    Returns Promise<string>

fromWords

fromWordsAsync

swapPrefix

swapPrefixAsync

  • Parameters

    • prefix: string
    • existingBech32: string
    • Optional LIMIT: number

    Returns Promise<string>

toWords

toWordsAsync

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

checkIfValid

checkIfValidAsync

decode

decodeAsync

encode

encodeAsync

fromWords

fromWordsAsync

swapPrefix

swapPrefixAsync

  • Parameters

    • prefix: string
    • existingBech32: string
    • Optional limit: number

    Returns Promise<string>

toWords

toWordsAsync

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/IDecoded.html b/docs/interfaces/IDecoded.html index 520a5a3..36d7987 100644 --- a/docs/interfaces/IDecoded.html +++ b/docs/interfaces/IDecoded.html @@ -1,3 +1,3 @@ -IDecoded | @jackallabs/bech32

Interface IDecoded

Hierarchy

  • IDecoded

Properties

prefix +IDecoded | @jackallabs/bech32

Interface IDecoded

Hierarchy

  • IDecoded

Properties

prefix words -

Properties

prefix

prefix: string

words

words: number[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

prefix

prefix: string

words

words: number[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/bech32.html b/docs/variables/bech32.html index 1e7448e..3ba335f 100644 --- a/docs/variables/bech32.html +++ b/docs/variables/bech32.html @@ -1 +1 @@ -bech32 | @jackallabs/bech32

Variable bech32Const

bech32: IBech32Handler = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +bech32 | @jackallabs/bech32

Variable bech32Const

bech32: IBech32Handler = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/bech32m.html b/docs/variables/bech32m.html index 56ac8eb..8a9a812 100644 --- a/docs/variables/bech32m.html +++ b/docs/variables/bech32m.html @@ -1 +1 @@ -bech32m | @jackallabs/bech32

Variable bech32mConst

bech32m: IBech32Handler = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +bech32m | @jackallabs/bech32

Variable bech32mConst

bech32m: IBech32Handler = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file