-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
removes IEntity and leaves it up to IResponsePayload to define such behavior
- Loading branch information
1 parent
a8bfd7f
commit 7985769
Showing
24 changed files
with
578 additions
and
344 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [ResourcePayload](./core.resourcepayload.md) | ||
|
||
## ResourcePayload class | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare abstract class ResourcePayload implements IResourcePayload | ||
``` | ||
## Methods | ||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [sha1()](./core.resourcepayload.sha1.md) | | <b><i>(BETA)</i></b> See [IResourcePayload.sha1()](./core.iresourcepayload.sha1.md)<!-- -->. | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [ResourcePayload](./core.resourcepayload.md) > [sha1](./core.resourcepayload.sha1.md) | ||
|
||
## ResourcePayload.sha1() method | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
See [IResourcePayload.sha1()](./core.iresourcepayload.sha1.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
sha1(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
||
## Remarks | ||
|
||
Does not omit any properties of the resource | ||
|
14 changes: 6 additions & 8 deletions
14
...markdown/core.ientityconstructor._new_.md → ...markdown/core.response_2._constructor_.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [IEntityConstructor](./core.ientityconstructor.md) > [(new)](./core.ientityconstructor._new_.md) | ||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) > [(constructor)](./core.response_2._constructor_.md) | ||
|
||
## IEntityConstructor.(new) | ||
## Response\_2.(constructor) | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
Constructs a new instance of the `Response` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
new (...args: any[]): IEntity; | ||
constructor(serializedResponse: any); | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| args | any\[\] | | | ||
<b>Returns:</b> | ||
[IEntity](./core.ientity.md) | ||
| serializedResponse | any | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) > [main](./core.response_2.main.md) | ||
|
||
## Response\_2.main property | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
<b>Signature:</b> | ||
|
||
```typescript | ||
main: IResponseResponse; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) | ||
|
||
## Response\_2 class | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
see [IResponse](./core.iresponse.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare abstract class Response implements IResponse | ||
``` | ||
## Constructors | ||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)(serializedResponse)](./core.response_2._constructor_.md) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>Response</code> class | | ||
## Properties | ||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [main](./core.response_2.main.md) | | [IResponseResponse](./core.iresponseresponse.md) | <b><i>(BETA)</i></b> | | ||
| [meta](./core.response_2.meta.md) | | [IResponseMeta](./core.iresponsemeta.md) | <b><i>(BETA)</i></b> | | ||
| [page](./core.response_2.page.md) | | [IResponsePage](./core.iresponsepage.md) | <b><i>(BETA)</i></b> | | ||
| [xhrs](./core.response_2.xhrs.md) | | [IResponseResponse](./core.iresponseresponse.md)<!-- -->\[\] | <b><i>(BETA)</i></b> | | ||
## Methods | ||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [toResources()](./core.response_2.toresources.md) | | <b><i>(BETA)</i></b> see [IResponse.toResources()](./core.iresponse.toresources.md)<!-- -->. Needs to be implemented by services. | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) > [meta](./core.response_2.meta.md) | ||
|
||
## Response\_2.meta property | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
<b>Signature:</b> | ||
|
||
```typescript | ||
meta: IResponseMeta; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) > [page](./core.response_2.page.md) | ||
|
||
## Response\_2.page property | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
<b>Signature:</b> | ||
|
||
```typescript | ||
page: IResponsePage; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) > [toResources](./core.response_2.toresources.md) | ||
|
||
## Response\_2.toResources() method | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
see [IResponse.toResources()](./core.iresponse.toresources.md)<!-- -->. Needs to be implemented by services. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
toResources(): ResourceResponse<ResourcePayload>; | ||
``` | ||
<b>Returns:</b> | ||
|
||
[ResourceResponse](./core.resourceresponse.md)<!-- --><[ResourcePayload](./core.resourcepayload.md)<!-- -->> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@authless/core](./core.md) > [Response\_2](./core.response_2.md) > [xhrs](./core.response_2.xhrs.md) | ||
|
||
## Response\_2.xhrs property | ||
|
||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. | ||
> | ||
<b>Signature:</b> | ||
|
||
```typescript | ||
xhrs: IResponseResponse[]; | ||
``` |
Oops, something went wrong.