@twin.org/web 0.0.3-next.21 → 0.0.3-next.23

package/docs/reference/classes/HeaderHelper.md

@@ -14,7 +14,7 @@ Class to helper with header operations.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### createBearer()
+### createBearer() {#createbearer}
 
 > `static` **createBearer**(`token`): `string`
 
@@ -44,7 +44,7 @@ The bearer token header.
 
 ***
 
-### extractBearer()
+### extractBearer() {#extractbearer}
 
 > `static` **extractBearer**(`header`): `string`
 
@@ -66,7 +66,7 @@ The extracted token if it exists.
 
 ***
 
-### extractLinkHeaderRelation()
+### extractLinkHeaderRelation() {#extractlinkheaderrelation}
 
 > `static` **extractLinkHeaderRelation**(`linkHeader`, `relation`): \{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
 
@@ -98,7 +98,7 @@ https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
 
 ***
 
-### extractLinkHeaders()
+### extractLinkHeaders() {#extractlinkheaders}
 
 > `static` **extractLinkHeaders**(`linkHeader`): `object`[] \| `undefined`
 
@@ -124,7 +124,7 @@ https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
 
 ***
 
-### extractLinkHeader()
+### extractLinkHeader() {#extractlinkheader}
 
 > `static` **extractLinkHeader**(`linkHeader`): \{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
 
@@ -150,7 +150,7 @@ https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
 
 ***
 
-### createLinkHeader()
+### createLinkHeader() {#createlinkheader}
 
 > `static` **createLinkHeader**(`url`, `urlQueryParams`, `rel`, `params?`): `string`
 

package/docs/reference/classes/Jwk.md

@@ -14,7 +14,7 @@ Class to handle JSON Web Keys.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### toCryptoKey()
+### toCryptoKey() {#tocryptokey}
 
 > `static` **toCryptoKey**(`jwk`, `alg?`): `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
 
@@ -50,7 +50,7 @@ The crypto key.
 
 ***
 
-### fromEd25519Private()
+### fromEd25519Private() {#fromed25519private}
 
 > `static` **fromEd25519Private**(`privateKey`, `overrideUse?`): `Promise`\<`JWK`\>
 
@@ -78,7 +78,7 @@ The crypto key.
 
 ***
 
-### fromEd25519Public()
+### fromEd25519Public() {#fromed25519public}
 
 > `static` **fromEd25519Public**(`publicKey`, `overrideUse?`): `Promise`\<`JWK`\>
 
@@ -106,7 +106,7 @@ The crypto key.
 
 ***
 
-### toRaw()
+### toRaw() {#toraw}
 
 > `static` **toRaw**(`jwk`): `Promise`\<\{ `publicKey?`: `Uint8Array`\<`ArrayBufferLike`\>; `privateKey?`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
@@ -128,7 +128,7 @@ The crypto key.
 
 ***
 
-### generateKid()
+### generateKid() {#generatekid}
 
 > `static` **generateKid**(`jwk`): `Promise`\<`string`\>
 

package/docs/reference/classes/Jws.md

@@ -14,7 +14,7 @@ Class to handle JSON Web Signatures.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > `static` **create**(`privateKey`, `hash`, `algOverride?`): `Promise`\<`string`\>
 
@@ -56,7 +56,7 @@ The signature.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > `static` **verify**(`jws`, `publicKey`, `hash`): `Promise`\<`boolean`\>
 

package/docs/reference/classes/Jwt.md

@@ -14,7 +14,7 @@ Class to handle JSON Web Tokens.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### encode()
+### encode() {#encode}
 
 > `static` **encode**\<`T`, `U`\>(`header`, `payload`, `key`): `Promise`\<`string`\>
 
@@ -66,7 +66,7 @@ The encoded token.
 
 ***
 
-### encodeWithSigner()
+### encodeWithSigner() {#encodewithsigner}
 
 > `static` **encodeWithSigner**\<`T`, `U`\>(`header`, `payload`, `signer`): `Promise`\<`string`\>
 
@@ -110,7 +110,7 @@ The encoded token.
 
 ***
 
-### decode()
+### decode() {#decode}
 
 > `static` **decode**\<`T`, `U`\>(`token`): `Promise`\<\{ `header?`: `T`; `payload?`: `U`; `signature?`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
@@ -142,7 +142,7 @@ The decoded payload.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > `static` **verify**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -180,7 +180,7 @@ The decoded payload.
 
 ***
 
-### verifyWithVerifier()
+### verifyWithVerifier() {#verifywithverifier}
 
 > `static` **verifyWithVerifier**\<`T`, `U`\>(`token`, `verifier`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -218,7 +218,7 @@ The decoded payload.
 
 ***
 
-### verifySignature()
+### verifySignature() {#verifysignature}
 
 > `static` **verifySignature**\<`T`, `U`\>(`token`, `key?`, `verifier?`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -262,7 +262,7 @@ True if the parts are verified.
 
 ***
 
-### defaultSigner()
+### defaultSigner() {#defaultsigner}
 
 > `static` **defaultSigner**(`header`, `payload`, `key`): `Promise`\<`string`\>
 
@@ -296,7 +296,7 @@ The signature.
 
 ***
 
-### defaultVerifier()
+### defaultVerifier() {#defaultverifier}
 
 > `static` **defaultVerifier**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -334,7 +334,7 @@ The header and payload if verification successful.
 
 ***
 
-### toSigningBytes()
+### toSigningBytes() {#tosigningbytes}
 
 > `static` **toSigningBytes**\<`T`, `U`\>(`header`, `payload`): `Uint8Array`
 
@@ -372,7 +372,7 @@ The bytes to sign.
 
 ***
 
-### fromSigningBytes()
+### fromSigningBytes() {#fromsigningbytes}
 
 > `static` **fromSigningBytes**\<`T`, `U`\>(`signingBytes`): `object`
 
@@ -416,7 +416,7 @@ If the signing bytes are invalid
 
 ***
 
-### tokenFromBytes()
+### tokenFromBytes() {#tokenfrombytes}
 
 > `static` **tokenFromBytes**(`signingBytes`, `signature`): `string`
 
@@ -444,7 +444,7 @@ The token.
 
 ***
 
-### tokenToBytes()
+### tokenToBytes() {#tokentobytes}
 
 > `static` **tokenToBytes**(`token`): `object`
 

package/docs/reference/classes/MimeTypeHelper.md

@@ -14,7 +14,7 @@ Class to help with mime types.
 
 ## Methods
 
-### detect()
+### detect() {#detect}
 
 > `static` **detect**(`data`): `Promise`\<`string` \| `undefined`\>
 
@@ -36,7 +36,7 @@ The mime type if detected.
 
 ***
 
-### defaultExtension()
+### defaultExtension() {#defaultextension}
 
 > `static` **defaultExtension**(`mimeType`): `string` \| `undefined`
 

package/docs/reference/interfaces/IFetchOptions.md

@@ -4,7 +4,7 @@ Options for call to the fetch helper.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
 > `optional` **headers**: [`IHttpHeaders`](IHttpHeaders.md)
 
@@ -14,7 +14,7 @@ The headers for the request.
 
 ***
 
-### timeoutMs?
+### timeoutMs? {#timeoutms}
 
 > `optional` **timeoutMs**: `number`
 
@@ -22,7 +22,7 @@ Timeout for requests in milliseconds.
 
 ***
 
-### includeCredentials?
+### includeCredentials? {#includecredentials}
 
 > `optional` **includeCredentials**: `boolean`
 
@@ -30,7 +30,7 @@ Include credentials in the requests.
 
 ***
 
-### retryCount?
+### retryCount? {#retrycount}
 
 > `optional` **retryCount**: `number`
 
@@ -38,7 +38,7 @@ The number of times to retry fetching defaults to no retries.
 
 ***
 
-### retryDelayMs?
+### retryDelayMs? {#retrydelayms}
 
 > `optional` **retryDelayMs**: `number`
 
@@ -46,7 +46,7 @@ The number of milliseconds we should delay before any retry.
 
 ***
 
-### cacheTtlMs?
+### cacheTtlMs? {#cachettlms}
 
 > `optional` **cacheTtlMs**: `number`
 

package/docs/reference/variables/HeaderTypes.md

@@ -6,7 +6,7 @@ Common http header types.
 
 ## Type Declaration
 
-### ContentType
+### ContentType {#contenttype}
 
 > `readonly` **ContentType**: `"content-type"` = `"content-type"`
 
@@ -16,7 +16,7 @@ Content Type.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
 
-### ContentLanguage
+### ContentLanguage {#contentlanguage}
 
 > `readonly` **ContentLanguage**: `"content-language"` = `"content-language"`
 
@@ -26,7 +26,7 @@ Content Language.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language
 
-### ContentLength
+### ContentLength {#contentlength}
 
 > `readonly` **ContentLength**: `"content-length"` = `"content-length"`
 
@@ -36,7 +36,7 @@ Content Length.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length
 
-### ContentDisposition
+### ContentDisposition {#contentdisposition}
 
 > `readonly` **ContentDisposition**: `"content-disposition"` = `"content-disposition"`
 
@@ -46,7 +46,7 @@ Content Disposition.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
 
-### ContentEncoding
+### ContentEncoding {#contentencoding}
 
 > `readonly` **ContentEncoding**: `"content-encoding"` = `"content-encoding"`
 
@@ -56,7 +56,7 @@ Content Encoding.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding
 
-### CacheControl
+### CacheControl {#cachecontrol}
 
 > `readonly` **CacheControl**: `"cache-control"` = `"cache-control"`
 
@@ -66,7 +66,7 @@ Cache Control.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
 
-### ETag
+### ETag {#etag}
 
 > `readonly` **ETag**: `"etag"` = `"etag"`
 
@@ -76,7 +76,7 @@ ETag.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
 
-### IfNoneMatch
+### IfNoneMatch {#ifnonematch}
 
 > `readonly` **IfNoneMatch**: `"if-none-match"` = `"if-none-match"`
 
@@ -86,7 +86,7 @@ If-None-Match.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match
 
-### LastModified
+### LastModified {#lastmodified}
 
 > `readonly` **LastModified**: `"last-modified"` = `"last-modified"`
 
@@ -96,7 +96,7 @@ Last-Modified.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified
 
-### IfModifiedSince
+### IfModifiedSince {#ifmodifiedsince}
 
 > `readonly` **IfModifiedSince**: `"if-modified-since"` = `"if-modified-since"`
 
@@ -106,7 +106,7 @@ If-Modified-Since.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since
 
-### Accept
+### Accept {#accept}
 
 > `readonly` **Accept**: `"accept"` = `"accept"`
 
@@ -116,7 +116,7 @@ Accept.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept
 
-### AcceptLanguage
+### AcceptLanguage {#acceptlanguage}
 
 > `readonly` **AcceptLanguage**: `"accept-language"` = `"accept-language"`
 
@@ -126,7 +126,7 @@ Accept-Language.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language
 
-### AcceptEncoding
+### AcceptEncoding {#acceptencoding}
 
 > `readonly` **AcceptEncoding**: `"accept-encoding"` = `"accept-encoding"`
 
@@ -136,7 +136,7 @@ Accept-Encoding.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Encoding
 
-### Authorization
+### Authorization {#authorization}
 
 > `readonly` **Authorization**: `"authorization"` = `"authorization"`
 
@@ -146,7 +146,7 @@ Authorization.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Authorization
 
-### WwwAuthenticate
+### WwwAuthenticate {#wwwauthenticate}
 
 > `readonly` **WwwAuthenticate**: `"www-authenticate"` = `"www-authenticate"`
 
@@ -156,7 +156,7 @@ WWW-Authenticate.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/WWW-Authenticate
 
-### Cookie
+### Cookie {#cookie}
 
 > `readonly` **Cookie**: `"cookie"` = `"cookie"`
 
@@ -166,7 +166,7 @@ Cookie.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cookie
 
-### SetCookie
+### SetCookie {#setcookie}
 
 > `readonly` **SetCookie**: `"set-cookie"` = `"set-cookie"`
 
@@ -176,7 +176,7 @@ Set Cookie.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie
 
-### Location
+### Location {#location}
 
 > `readonly` **Location**: `"location"` = `"location"`
 
@@ -186,7 +186,7 @@ Location
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Location
 
-### Origin
+### Origin {#origin}
 
 > `readonly` **Origin**: `"origin"` = `"origin"`
 
@@ -196,7 +196,7 @@ Origin.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
 
-### Referer
+### Referer {#referer}
 
 > `readonly` **Referer**: `"referer"` = `"referer"`
 
@@ -206,7 +206,7 @@ Referer.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer
 
-### Link
+### Link {#link}
 
 > `readonly` **Link**: `"link"` = `"link"`
 
@@ -216,7 +216,7 @@ Link
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
 
-### Vary
+### Vary {#vary}
 
 > `readonly` **Vary**: `"vary"` = `"vary"`
 
@@ -226,7 +226,7 @@ Vary.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary
 
-### AccessControlAllowOrigin
+### AccessControlAllowOrigin {#accesscontrolalloworigin}
 
 > `readonly` **AccessControlAllowOrigin**: `"access-control-allow-origin"` = `"access-control-allow-origin"`
 
@@ -236,7 +236,7 @@ Access-Control-Allow-Origin.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
 
-### AccessControlAllowMethods
+### AccessControlAllowMethods {#accesscontrolallowmethods}
 
 > `readonly` **AccessControlAllowMethods**: `"access-control-allow-methods"` = `"access-control-allow-methods"`
 
@@ -246,7 +246,7 @@ Access-Control-Allow-Methods.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
 
-### AccessControlAllowHeaders
+### AccessControlAllowHeaders {#accesscontrolallowheaders}
 
 > `readonly` **AccessControlAllowHeaders**: `"access-control-allow-headers"` = `"access-control-allow-headers"`
 
@@ -256,7 +256,7 @@ Access-Control-Allow-Headers.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
 
-### AccessControlExposeHeaders
+### AccessControlExposeHeaders {#accesscontrolexposeheaders}
 
 > `readonly` **AccessControlExposeHeaders**: `"access-control-expose-headers"` = `"access-control-expose-headers"`
 
@@ -266,7 +266,7 @@ Access-Control-Expose-Headers.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers
 
-### AccessControlMaxAge
+### AccessControlMaxAge {#accesscontrolmaxage}
 
 > `readonly` **AccessControlMaxAge**: `"access-control-max-age"` = `"access-control-max-age"`
 
@@ -276,7 +276,7 @@ Access-Control-Max-Age.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age
 
-### AccessControlAllowCredentials
+### AccessControlAllowCredentials {#accesscontrolallowcredentials}
 
 > `readonly` **AccessControlAllowCredentials**: `"access-control-allow-credentials"` = `"access-control-allow-credentials"`
 
@@ -286,7 +286,7 @@ Access-Control-Allow-Credentials.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials
 
-### Range
+### Range {#range}
 
 > `readonly` **Range**: `"range"` = `"range"`
 
@@ -296,7 +296,7 @@ Range.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range
 
-### AcceptRanges
+### AcceptRanges {#acceptranges}
 
 > `readonly` **AcceptRanges**: `"accept-ranges"` = `"accept-ranges"`
 
@@ -306,7 +306,7 @@ Accept-Ranges.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Ranges
 
-### ContentRange
+### ContentRange {#contentrange}
 
 > `readonly` **ContentRange**: `"content-range"` = `"content-range"`
 
@@ -316,7 +316,7 @@ Content-Range.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range
 
-### UserAgent
+### UserAgent {#useragent}
 
 > `readonly` **UserAgent**: `"user-agent"` = `"user-agent"`
 

package/docs/reference/variables/HttpMethod.md

@@ -6,7 +6,7 @@ The names of the HTTP Methods.
 
 ## Type Declaration
 
-### GET
+### GET {#get}
 
 > `readonly` **GET**: `"GET"` = `"GET"`
 
@@ -16,7 +16,7 @@ Retrieve a representation of the resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
 
-### POST
+### POST {#post}
 
 > `readonly` **POST**: `"POST"` = `"POST"`
 
@@ -26,7 +26,7 @@ Submit an entity to the specified resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
 
-### PUT
+### PUT {#put}
 
 > `readonly` **PUT**: `"PUT"` = `"PUT"`
 
@@ -36,7 +36,7 @@ Replace all current representations of the target resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
 
-### PATCH
+### PATCH {#patch}
 
 > `readonly` **PATCH**: `"PATCH"` = `"PATCH"`
 
@@ -46,7 +46,7 @@ Apply partial modifications to a resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
 
-### DELETE
+### DELETE {#delete}
 
 > `readonly` **DELETE**: `"DELETE"` = `"DELETE"`
 
@@ -56,7 +56,7 @@ Delete the specified resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
 
-### OPTIONS
+### OPTIONS {#options}
 
 > `readonly` **OPTIONS**: `"OPTIONS"` = `"OPTIONS"`
 
@@ -66,7 +66,7 @@ Describe the communication options for the target resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
 
-### HEAD
+### HEAD {#head}
 
 > `readonly` **HEAD**: `"HEAD"` = `"HEAD"`
 
@@ -76,7 +76,7 @@ Ask for a response identical to GET, but without the response body.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
 
-### CONNECT
+### CONNECT {#connect}
 
 > `readonly` **CONNECT**: `"CONNECT"` = `"CONNECT"`
 
@@ -86,7 +86,7 @@ Establish a tunnel to the server identified by the target resource.
 
 https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT
 
-### TRACE
+### TRACE {#trace}
 
 > `readonly` **TRACE**: `"TRACE"` = `"TRACE"`