From df4c682aee31a1337bbfa23944e6896679eeac32 Mon Sep 17 00:00:00 2001 From: Erin Rivas Date: Thu, 18 Jan 2024 15:28:09 -0600 Subject: [PATCH] docs update --- docs/index.html | 4 ++-- docs/interfaces/IBech32Handler.html | 4 ++-- docs/interfaces/IDecoded.html | 4 ++-- docs/variables/bech32.html | 2 +- docs/variables/bech32m.html | 2 +- docsreadme.md | 2 +- src/index.ts | 6 ++++-- 7 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/index.html b/docs/index.html index 4c43aeb..2a41602 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,2 +1,2 @@ -@jackallabs/bech32

@jackallabs/bech32

Sample Docs

These docs are generated and may not contain the most current version of the JSDocs.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

@jackallabs/bech32

@jackallabs/bech32 Docs

These docs are generated and may not contain the most current version of the JSDocs.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/IBech32Handler.html b/docs/interfaces/IBech32Handler.html index c599264..540ec7e 100644 --- a/docs/interfaces/IBech32Handler.html +++ b/docs/interfaces/IBech32Handler.html @@ -1,4 +1,4 @@ -IBech32Handler | @jackallabs/bech32

Interface IBech32Handler

Hierarchy

  • IBech32Handler

Methods

decode +IBech32Handler | @jackallabs/bech32

Interface IBech32Handler

Hierarchy

  • IBech32Handler

Methods

decode decodeAsync encode encodeAsync @@ -8,4 +8,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

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 diff --git a/docs/interfaces/IDecoded.html b/docs/interfaces/IDecoded.html index 3852ac1..be04abc 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 58e3e6c..6305185 100644 --- a/docs/variables/bech32.html +++ b/docs/variables/bech32.html @@ -1 +1 @@ -bech32 | @jackallabs/bech32

Variable bech32Const

bech32: Bech32Handler = ...

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 eeece09..52267d1 100644 --- a/docs/variables/bech32m.html +++ b/docs/variables/bech32m.html @@ -1 +1 @@ -bech32m | @jackallabs/bech32

Variable bech32mConst

bech32m: Bech32Handler = ...

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 diff --git a/docsreadme.md b/docsreadme.md index e660763..e1ccb61 100644 --- a/docsreadme.md +++ b/docsreadme.md @@ -1,3 +1,3 @@ -# Sample Docs +# @jackallabs/bech32 Docs These docs are generated and may not contain the most current version of the JSDocs. diff --git a/src/index.ts b/src/index.ts index ca6f616..d127871 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,7 @@ import { Bech32Handler } from '@/classes' +import { IBech32Handler } from '@/interfaces' + export * from '@/interfaces' -export const bech32 = new Bech32Handler('bech32') -export const bech32m = new Bech32Handler('bech32m') +export const bech32: IBech32Handler = new Bech32Handler('bech32') +export const bech32m: IBech32Handler = new Bech32Handler('bech32m')