docs

Jwt-js-decode Documentation

Jwt-js-decode Documentation

Table of contents

Classes

• ASN1
• Asn1Tag
• JwtDecode
• JwtSplit

Interfaces

• JwtPart
• PEM

Variables

• CRYPTO_NOT_FOUND
• ILLEGAL_ARGUMENT
• PAKO_NOT_FOUND
• UNSUPPORTED_ALGORITHM
• UNSUPPORTED_ZIP_TYPE
• webCrypto
• webCryptoSubtle

Functions

• AB2hex
• AB2s
• J2s
• algHSsign
• algHSverify
• algRSsign
• algRSverify
• algSign
• algVerify
• asn12jwk
• b2bu
• b2s
• bu2b
• bu2s
• cleanZeros
• createHmac
• createSign
• createVerify
• decode
• decodeJwt
• generateErrorMessage
• getTextDecoder
• getTextEncoder
• hex2AB
• isGzip
• jwtDecode
• jwtResign
• jwtSign
• jwtSplit
• jwtVerify
• notLatin1String
• num2hex
• pem2asn1
• pem2jwk
• resign
• resignJwt
• s2AB
• s2J
• s2U8A
• s2b
• s2bu
• s2pem
• s2zbu
• sign
• signJwt
• split
• splitJwt
• textDecode
• textEncode
• tryPromise
• unzip
• verify
• verifyJwt
• zbu2s
• zip

Variables

CRYPTO_NOT_FOUND

• Const CRYPTO_NOT_FOUND: "Could not find 'crypto'."

Defined in

util.ts:4

---

ILLEGAL_ARGUMENT

• Const ILLEGAL_ARGUMENT: "Illegal argument specified!"

Defined in

util.ts:3

---

PAKO_NOT_FOUND

• Const PAKO_NOT_FOUND: "Could not find 'pako'."

Defined in

util.ts:5

---

UNSUPPORTED_ALGORITHM

• Const UNSUPPORTED_ALGORITHM: "Unsupported algorithm name specified! Supported algorithms: \"HS256\", \"HS384\", \"HS512\", \"RS256\", \"RS384\", \"RS512\" and \"none\"."

Defined in

util.ts:1

---

UNSUPPORTED_ZIP_TYPE

• Const UNSUPPORTED_ZIP_TYPE: "Unsupported zip type."

Defined in

util.ts:6

---

webCrypto

• Const webCrypto: false | Crypto

Defined in

jwt-js-decode.ts:17

---

webCryptoSubtle

• Const webCryptoSubtle: false | SubtleCrypto

Defined in

jwt-js-decode.ts:18

Functions

AB2hex

▸ AB2hex(buff): string

Parameters

Name	Type
buff	ArrayBuffer | Uint8Array

Returns

string

Defined in

util.ts:36

---

AB2s

▸ AB2s(buff): string

Converts ArrayBuffer to string

Parameters

Name	Type	Description
buff	ArrayBuffer | Uint8Array	charCode ArrayBuffer to convert

Returns

string

data string

Defined in

jwt-js-decode.ts:425

---

J2s

▸ J2s(obj): string

Converts JSON object to string

Parameters

Name	Type	Description
obj	any	JSON object to convert

Returns

string

resulting string

Defined in

jwt-js-decode.ts:177

---

algHSsign

▸ algHSsign(bits): (thing: string, secret: string) => Promise<string>

Algorithm HMAC sign generator

Parameters

Name	Type
bits	number

Returns

fn

▸ (thing, secret): Promise<string>

Parameters

Name	Type
thing	string
secret	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:459

---

algHSverify

▸ algHSverify(bits): (thing: string, signature: string, secret: string) => Promise<boolean>

Algorithm HMAC verify generator

Parameters

Name	Type
bits	number

Returns

fn

▸ (thing, signature, secret): Promise<boolean>

Parameters

Name	Type
thing	string
signature	string
secret	string

Returns

Promise<boolean>

Defined in

jwt-js-decode.ts:478

---

algRSsign

▸ algRSsign(bits): (thing: string, privateKey: string) => Promise<string>

Parameters

Name	Type
bits	number

Returns

fn

▸ (thing, privateKey): Promise<string>

Parameters

Name	Type
thing	string
privateKey	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:649

---

algRSverify

▸ algRSverify(bits): (thing: string, signature: string, publicKey: string) => Promise<boolean>

Parameters

Name	Type
bits	number

Returns

fn

▸ (thing, signature, publicKey): Promise<boolean>

Parameters

Name	Type
thing	string
signature	string
publicKey	string

Returns

Promise<boolean>

Defined in

jwt-js-decode.ts:701

---

algSign

▸ algSign(algorithm, thing, secret): Promise<string>

Universal algorithm signer

Parameters

Name	Type
algorithm	string
thing	string
secret	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:747

---

algVerify

▸ algVerify(algorithm, thing, signature, secret): Promise<boolean>

Universal algorithm verifier

Parameters

Name	Type
algorithm	string
thing	string
signature	string
secret	string

Returns

Promise<boolean>

Defined in

jwt-js-decode.ts:717

---

asn12jwk

▸ asn12jwk(asn1, type?, extra?): any

Parameters

Name	Type
asn1	any
type?	string
extra?	any

Returns

any

Defined in

jwt-js-decode.ts:570

---

b2bu

▸ b2bu(str): string

Converts base64 string to base64url string

Parameters

Name	Type	Description
str	string	data string to convert

Returns

string

base64url string

Defined in

jwt-js-decode.ts:203

---

b2s

▸ b2s(str): string

Converts string to base64 string

Parameters

Name	Type	Description
str	string	data string to convert

Returns

string

decoded data string

Defined in

jwt-js-decode.ts:188

---

bu2b

▸ bu2b(str): string

Converts base64url string to base64 string

Parameters

Name	Type	Description
str	string	data string to convert

Returns

string

base64 string

Defined in

jwt-js-decode.ts:219

---

bu2s

▸ bu2s(str): string

Converts base64url string to string

Parameters

Name	Type	Description
str	string	base64url string to convert

Returns

string

decoded data string

Defined in

jwt-js-decode.ts:237

---

cleanZeros

▸ cleanZeros(b): any

Parameters

Name	Type
b	any

Returns

any

Defined in

util.ts:25

---

createHmac

▸ createHmac(name, secret): Promise<any>

Async function inspired by createHmac in crypto (used WebCrypto Api supported by most browsers)

Parameters

Name	Type
name	string
secret	string

Returns

Promise<any>

Defined in

jwt-js-decode.ts:435

---

createSign

▸ createSign(name): Promise<any>

Parameters

Name	Type
name	string

Returns

Promise<any>

Defined in

jwt-js-decode.ts:614

---

createVerify

▸ createVerify(name): Promise<any>

Parameters

Name	Type
name	string

Returns

Promise<any>

Defined in

jwt-js-decode.ts:660

---

decode

▸ decode(str, callee?): JwtDecode

Decode jwtToken header and payload

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to decode
callee	string	'jwtDecode'	-

Returns

JwtDecode

object with decoded header and body, and signature untouched

Defined in

jwt-js-decode.ts:264

---

decodeJwt

▸ decodeJwt(str, callee?): JwtDecode

Decode jwtToken header and payload

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to decode
callee	string	'jwtDecode'	-

Returns

JwtDecode

object with decoded header and body, and signature untouched

Defined in

jwt-js-decode.ts:263

---

generateErrorMessage

▸ generateErrorMessage(value, callee, argumentName?, defaultType?): string

Parameters

Name	Type	Default value
value	any	undefined
callee	any	undefined
argumentName	string	'argument'
defaultType	string	'string'

Returns

string

Defined in

util.ts:8

---

getTextDecoder

▸ getTextDecoder(...args): TextDecoder | false

Parameters

Name	Type
...args	any[]

Returns

TextDecoder | false

Defined in

jwt-js-decode.ts:863

---

getTextEncoder

▸ getTextEncoder(): TextEncoder | false

Returns

TextEncoder | false

Defined in

jwt-js-decode.ts:850

---

hex2AB

▸ hex2AB(hex): ArrayBuffer | Uint8Array

Parameters

Name	Type
hex	string

Returns

ArrayBuffer | Uint8Array

Defined in

util.ts:29

---

isGzip

▸ isGzip(header): boolean

Check if header has zip property (and it is equal to 'GZIP', ignorecase)

Parameters

Name	Type	Description
header	JwtPart	object to check

Returns

boolean

does it have gzip in zip property

Defined in

jwt-js-decode.ts:248

---

jwtDecode

▸ jwtDecode(str, callee?): JwtDecode

Decode jwtToken header and payload

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to decode
callee	string	'jwtDecode'	-

Returns

JwtDecode

object with decoded header and body, and signature untouched

Defined in

jwt-js-decode.ts:259

---

jwtResign

▸ jwtResign(jwtStr, secret, alg?): Promise<string>

Parameters

Name	Type
jwtStr	string
secret	string
alg?	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:793

---

jwtSign

▸ jwtSign(jwtStr, secret): Promise<string>

Parameters

Name	Type
jwtStr	string
secret	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:783

---

jwtSplit

▸ jwtSplit(str, callee?): JwtSplit

Split jwtToken into object {header, payload, signature}

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to split
callee	string	'jwtSplit'	-

Returns

JwtSplit

jwt split object of three strings

Defined in

jwt-js-decode.ts:273

---

jwtVerify

▸ jwtVerify(jwtStr, secret): Promise<boolean>

Parameters

Name	Type
jwtStr	string
secret	string

Returns

Promise<boolean>

Defined in

jwt-js-decode.ts:773

---

notLatin1String

▸ notLatin1String(str): boolean

Parameters

Name	Type
str	any

Returns

boolean

Defined in

jwt-js-decode.ts:813

---

num2hex

▸ num2hex(memo, i): string

Parameters

Name	Type
memo	string
i	number

Returns

string

Defined in

util.ts:20

---

pem2asn1

▸ pem2asn1(buff): any

Parameters

Name	Type
buff	ArrayBuffer | Uint8Array

Returns

any

Defined in

jwt-js-decode.ts:533

---

pem2jwk

▸ pem2jwk(secret, type?, extra?): Promise<any>

Parameters

Name	Type
secret	string
type?	"private" | "public"
extra?	any

Returns

Promise<any>

Defined in

jwt-js-decode.ts:607

---

resign

▸ resign(jwtStr, secret, alg?): Promise<string>

Parameters

Name	Type
jwtStr	string
secret	string
alg?	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:801

---

resignJwt

▸ resignJwt(jwtStr, secret, alg?): Promise<string>

Parameters

Name	Type
jwtStr	string
secret	string
alg?	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:800

---

s2AB

▸ s2AB(str): ArrayBuffer

Converts string to ArrayBuffer

Parameters

Name	Type	Description
str	string	data string to convert

Returns

ArrayBuffer

charCode ArrayBuffer

Defined in

jwt-js-decode.ts:397

---

s2J

▸ s2J(str): any

Converts string to JSON object

Parameters

Name	Type	Description
str	string	data string to convert

Returns

any

resulting object

Defined in

jwt-js-decode.ts:166

---

s2U8A

▸ s2U8A(str): ArrayBuffer

Converts string to Uint8Array

Parameters

Name	Type	Description
str	string	data string to convert

Returns

ArrayBuffer

charCode Uint8Array

Defined in

jwt-js-decode.ts:411

---

s2b

▸ s2b(str): string

Converts base64 string to string

Parameters

Name	Type	Description
str	string	data string to convert

Returns

string

base64 string

Defined in

jwt-js-decode.ts:287

---

s2bu

▸ s2bu(str): string

Converts string to base64url string

Parameters

Name	Type	Description
str	string	data string to convert

Returns

string

base64url string

Defined in

jwt-js-decode.ts:302

---

s2pem

▸ s2pem(secret): PEM

Parameters

Name	Type
secret	string

Returns

PEM

Defined in

jwt-js-decode.ts:493

---

s2zbu

▸ s2zbu(str, type?): string

Zip and encode data string to base64url string

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to encode
type	string	'zlib'	type of zip type: "zlib", "gzip". default: "zlib"

Returns

string

base64url string

Defined in

jwt-js-decode.ts:314

---

sign

▸ sign(jwtStr, secret): Promise<string>

Parameters

Name	Type
jwtStr	string
secret	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:791

---

signJwt

▸ signJwt(jwtStr, secret): Promise<string>

Parameters

Name	Type
jwtStr	string
secret	string

Returns

Promise<string>

Defined in

jwt-js-decode.ts:790

---

split

▸ split(str, callee?): JwtSplit

Split jwtToken into object {header, payload, signature}

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to split
callee	string	'jwtSplit'	-

Returns

JwtSplit

jwt split object of three strings

Defined in

jwt-js-decode.ts:278

---

splitJwt

▸ splitJwt(str, callee?): JwtSplit

Split jwtToken into object {header, payload, signature}

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to split
callee	string	'jwtSplit'	-

Returns

JwtSplit

jwt split object of three strings

Defined in

jwt-js-decode.ts:277

---

textDecode

▸ textDecode(input): string

Parameters

Name	Type
input	string | Buffer

Returns

string

Defined in

jwt-js-decode.ts:827

---

textEncode

▸ textEncode(input): ArrayBuffer

Parameters

Name	Type
input	string

Returns

ArrayBuffer

Defined in

jwt-js-decode.ts:817

---

tryPromise

▸ tryPromise(fn): Promise<any>

Try running function and replace it's response as Promise.resolve/reject

Parameters

Name	Type	Description
fn	any	fn to call in for response

Returns

Promise<any>

resulting Promise

Defined in

jwt-js-decode.ts:151

---

unzip

▸ unzip(str): string

Converts from zip data string to string

Parameters

Name	Type	Description
str	string	data string to convert

Returns

string

decoded data string

Defined in

jwt-js-decode.ts:325

---

verify

▸ verify(jwtStr, secret): Promise<boolean>

Parameters

Name	Type
jwtStr	string
secret	string

Returns

Promise<boolean>

Defined in

jwt-js-decode.ts:781

---

verifyJwt

▸ verifyJwt(jwtStr, secret): Promise<boolean>

Parameters

Name	Type
jwtStr	string
secret	string

Returns

Promise<boolean>

Defined in

jwt-js-decode.ts:780

---

zbu2s

▸ zbu2s(str): string

Decode from base64url and unzip data string

Parameters

Name	Type	Description
str	string	data string to decode

Returns

string

decoded data string

Defined in

jwt-js-decode.ts:356

---

zip

▸ zip(str, type?): string

Converts string to zip data string

Parameters

Name	Type	Default value	Description
str	string	undefined	data string to convert
type	string	'zlib'	type of zip type: "zlib", "gzip". default: "zlib"

Returns

string

zip data string

Defined in

jwt-js-decode.ts:368