npm - @twin.org/web - Versions diffs - 0.0.1-next.3 → 0.0.1-next.31 - Mend

@twin.org/web 0.0.1-next.3 → 0.0.1-next.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

package/dist/cjs/index.cjs +9 -262
package/dist/esm/index.mjs +9 -262
package/dist/types/models/headerTypes.d.ts +8 -8
package/dist/types/models/mimeTypes.d.ts +4 -0
package/docs/changelog.md +1 -1
package/docs/reference/classes/FetchError.md +13 -331
package/docs/reference/classes/FetchHelper.md +51 -17
package/docs/reference/classes/Jwt.md +75 -73
package/docs/reference/classes/MimeTypeHelper.md +6 -2
package/docs/reference/interfaces/IHttpHeaders.md +1 -1
package/docs/reference/interfaces/IJwk.md +1 -1
package/docs/reference/interfaces/IJwtHeader.md +1 -1
package/docs/reference/interfaces/IJwtPayload.md +1 -1
package/docs/reference/variables/HeaderTypes.md +8 -8
package/docs/reference/variables/MimeTypes.md +6 -0
package/package.json +5 -32

package/docs/reference/classes/FetchError.md CHANGED Viewed

@@ -16,23 +16,31 @@ Create a new instance of FetchError.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source of the error.
-• **message**: `string`
+##### message
+`string`
 The message as a code.
-• **httpStatus**: [`HttpStatusCode`](../type-aliases/HttpStatusCode.md)
+##### httpStatus
+[`HttpStatusCode`](../type-aliases/HttpStatusCode.md)
 The http status code.
-• **properties?**
+##### properties?
 Any additional information for the error.
-• **inner?**: `unknown`
+##### inner?
+`unknown`
 The inner error if we have wrapped another error.
@@ -46,334 +54,8 @@ The inner error if we have wrapped another error.
 ## Properties
-### source?
-> `optional` **source**: `string`
-The source of the error.
-#### Inherited from
-`BaseError.source`
-***
-### properties?
-> `optional` **properties**: `object`
-Any additional information for the error.
-#### Index Signature
- \[`id`: `string`\]: `unknown`
-#### Inherited from
-`BaseError.properties`
-***
-### inner?
-> `optional` **inner**: `IError`
-The inner error if there was one.
-#### Inherited from
-`BaseError.inner`
-***
 ### CLASS\_NAME
 > `readonly` `static` **CLASS\_NAME**: `string`
 Runtime name for the class.
-## Methods
-### fromError()
-> `static` **fromError**(`err`): `BaseError`
-Construct an error from an existing one.
-#### Parameters
-• **err**: `unknown`
-The existing error.
-#### Returns
-`BaseError`
-The new instance.
-#### Inherited from
-`BaseError.fromError`
-***
-### flatten()
-> `static` **flatten**(`err`): `IError`[]
-Flatten an error tree.
-#### Parameters
-• **err**: `unknown`
-The starting error.
-#### Returns
-`IError`[]
-The list of all internal errors.
-#### Inherited from
-`BaseError.flatten`
-***
-### expand()
-> `static` **expand**(`errors`): `undefined` \| `IError`
-Expand an error tree.
-#### Parameters
-• **errors**: `undefined` \| `IError`[]
-The list of errors to expand.
-#### Returns
-`undefined` \| `IError`
-The first level error.
-#### Inherited from
-`BaseError.expand`
-***
-### isErrorName()
-> `static` **isErrorName**(`error`, `name`): `error is BaseError`
-Test to see if the error has the specified error name.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **name**: `string` \| `RegExp`
-The name to check for.
-#### Returns
-`error is BaseError`
-True if the error has the name.
-#### Inherited from
-`BaseError.isErrorName`
-***
-### isErrorMessage()
-> `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
-Test to see if the error has the specified error message.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **message**: `string` \| `RegExp`
-The message to check for.
-#### Returns
-`error is BaseError`
-True if the error has the name.
-#### Inherited from
-`BaseError.isErrorMessage`
-***
-### isErrorCode()
-> `static` **isErrorCode**(`error`, `code`): `boolean`
-Test to see if the error has the specified error code.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **code**: `string` \| `RegExp`
-The code to check for.
-#### Returns
-`boolean`
-True if the error has the code.
-#### Inherited from
-`BaseError.isErrorCode`
-***
-### someErrorName()
-> `static` **someErrorName**(`error`, `name`): `error is BaseError`
-Test to see if any of the errors or children have the given error name.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **name**: `string` \| `RegExp`
-The name to check for.
-#### Returns
-`error is BaseError`
-True if the error has the name.
-#### Inherited from
-`BaseError.someErrorName`
-***
-### someErrorMessage()
-> `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
-Test to see if any of the errors or children have the given error message.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **message**: `string` \| `RegExp`
-The message to check for.
-#### Returns
-`error is BaseError`
-True if the error has the name.
-#### Inherited from
-`BaseError.someErrorMessage`
-***
-### someErrorClass()
-> `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
-Test to see if any of the errors or children are from a specific class.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **cls**: `string`
-The class to check for.
-#### Returns
-`error is BaseError`
-True if the error has the specific class.
-#### Inherited from
-`BaseError.someErrorClass`
-***
-### someErrorCode()
-> `static` **someErrorCode**(`error`, `code`): `error is BaseError`
-Test to see if any of the errors or children have the given error code.
-#### Parameters
-• **error**: `unknown`
-The error to test.
-• **code**: `string` \| `RegExp`
-The code to check for.
-#### Returns
-`error is BaseError`
-True if the error has the name.
-#### Inherited from
-`BaseError.someErrorCode`
-***
-### toJsonObject()
-> **toJsonObject**(): `IError`
-Serialize the error to the error model.
-#### Returns
-`IError`
-The error model.
-#### Inherited from
-`BaseError.toJsonObject`

package/docs/reference/classes/FetchHelper.md CHANGED Viewed

@@ -22,23 +22,33 @@ Perform a fetch request.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source for the request.
-• **url**: `string`
+##### url
+`string`
 The url for the request.
-• **method**: [`HttpMethod`](../type-aliases/HttpMethod.md)
+##### method
+[`HttpMethod`](../type-aliases/HttpMethod.md)
 The http method.
-• **body?**: `string` \| `Uint8Array`
+##### body?
 Request to send to the endpoint.
-• **options?**: `Omit`\<[`IFetchOptions`](../interfaces/IFetchOptions.md), `"cacheTtlSeconds"`\>
+`string` | `Uint8Array`
+##### options?
+`Omit`\<[`IFetchOptions`](../interfaces/IFetchOptions.md), `"cacheTtlSeconds"`\>
 Options for sending the requests.
@@ -64,23 +74,33 @@ Perform a request in json format.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source for the request.
-• **url**: `string`
+##### url
+`string`
 The url for the request.
-• **method**: [`HttpMethod`](../type-aliases/HttpMethod.md)
+##### method
+[`HttpMethod`](../type-aliases/HttpMethod.md)
 The http method.
-• **requestData?**: `T`
+##### requestData?
+`T`
 Request to send to the endpoint.
-• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+##### options?
+[`IFetchOptions`](../interfaces/IFetchOptions.md)
 Options for sending the requests.
@@ -104,23 +124,33 @@ Perform a request for binary data.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source for the request.
-• **url**: `string`
+##### url
+`string`
 The url for the request.
-• **method**: `"GET"` \| `"POST"`
+##### method
 The http method.
-• **requestData?**: `Uint8Array`
+`"GET"` | `"POST"`
+##### requestData?
+`Uint8Array`
 Request to send to the endpoint.
-• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+##### options?
+[`IFetchOptions`](../interfaces/IFetchOptions.md)
 Options for sending the requests.
@@ -156,7 +186,9 @@ Get a cache entry.
 #### Parameters
-• **url**: `string`
+##### url
+`string`
 The url for the request.
@@ -176,7 +208,9 @@ Remove a cache entry.
 #### Parameters
-• **url**: `string`
+##### url
+`string`
 The url for the request.