Skip to content

Commit 1f36476

Browse files
alien-mcllanthaler
alien-mcl
authored and
lanthaler
committed
First version of reference client including some interface documentation (#1)
* Initial commit. * Changes after PR feedback.
1 parent aaddb2f commit 1f36476

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+2388
-0
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
.idea
3+
.vs
4+
bin

‎doc/classes/_src_apidocumentation_.apidocumentation.md

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
[hydraclient.js](../index.md) > ["src/ApiDocumentation"](../modules/_src_apidocumentation_.md) > [ApiDocumentation](../classes/_src_apidocumentation_.apidocumentation.md)
2+
3+
4+
5+
# Class: ApiDocumentation
6+
7+
## Implements
8+
9+
* [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md)
10+
11+
## Index
12+
13+
### Properties
14+
15+
* [client](_src_apidocumentation_.apidocumentation.md#client)
16+
* [description](_src_apidocumentation_.apidocumentation.md#description)
17+
* [entryPoint](_src_apidocumentation_.apidocumentation.md#entrypoint)
18+
* [supportedClasses](_src_apidocumentation_.apidocumentation.md#supportedclasses)
19+
* [supportedOperations](_src_apidocumentation_.apidocumentation.md#supportedoperations)
20+
* [title](_src_apidocumentation_.apidocumentation.md#title)
21+
22+
23+
### Methods
24+
25+
* [ApiDocumentation](_src_apidocumentation_.apidocumentation.md#apidocumentation)
26+
* [getEntryPoint](_src_apidocumentation_.apidocumentation.md#getentrypoint)
27+
28+
29+
30+
## Properties
31+
<a id="client"></a>
32+
33+
### client
34+
35+
**client**: *[HydraClient](_src_hydraclient_.hydraclient.md)*
36+
37+
*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[client](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#client)*
38+
39+
*Defined in [src/ApiDocumentation.ts:19](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L19)*
40+
41+
42+
43+
44+
___
45+
46+
<a id="description"></a>
47+
48+
### «Optional» description
49+
50+
**description**: *string*
51+
52+
*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[description](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#description)*
53+
54+
*Defined in [src/ApiDocumentation.ts:11](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L11)*
55+
56+
57+
58+
59+
___
60+
61+
<a id="entrypoint"></a>
62+
63+
### entryPoint
64+
65+
**entryPoint**: *string*
66+
67+
*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[entryPoint](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#entrypoint)*
68+
69+
*Defined in [src/ApiDocumentation.ts:17](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L17)*
70+
71+
72+
73+
74+
___
75+
76+
<a id="supportedclasses"></a>
77+
78+
### supportedClasses
79+
80+
**supportedClasses**: *Array<[IClass](../interfaces/_src_datamodel_iclass_.iclass.md)>*
81+
82+
*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[supportedClasses](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#supportedclasses)*
83+
84+
*Defined in [src/ApiDocumentation.ts:13](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L13)*
85+
86+
87+
88+
89+
___
90+
91+
<a id="supportedoperations"></a>
92+
93+
### supportedOperations
94+
95+
**supportedOperations**: *Array<[IOperation](../interfaces/_src_datamodel_ioperation_.ioperation.md)>*
96+
97+
*Defined in [src/ApiDocumentation.ts:15](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L15)*
98+
99+
100+
101+
102+
___
103+
104+
<a id="title"></a>
105+
106+
### «Optional» title
107+
108+
**title**: *string*
109+
110+
*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[title](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#title)*
111+
112+
*Defined in [src/ApiDocumentation.ts:9](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L9)*
113+
114+
115+
116+
117+
___
118+
119+
120+
## Methods
121+
<a id="apidocumentation"></a>
122+
123+
### ApiDocumentation
124+
125+
► **ApiDocumentation**(): void
126+
127+
128+
129+
*Defined in [src/ApiDocumentation.ts:21](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L21)*
130+
131+
132+
133+
**Returns:** void
134+
135+
136+
137+
138+
139+
___
140+
141+
<a id="getentrypoint"></a>
142+
143+
### getEntryPoint
144+
145+
► **getEntryPoint**(): Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
146+
147+
148+
149+
*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[getEntryPoint](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#getentrypoint)*
150+
151+
*Defined in [src/ApiDocumentation.ts:28](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L28)*
152+
153+
154+
155+
**Returns:** Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
156+
157+
158+
159+
160+
161+
___
162+
163+

‎doc/classes/_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md

+190
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
[hydraclient.js](../index.md) > ["src/DataModel/JsonLd/JsonLdHypermediaProcessor"](../modules/_src_datamodel_jsonld_jsonldhypermediaprocessor_.md) > [JsonLdHypermediaProcessor](../classes/_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md)
2+
3+
4+
5+
# Class: JsonLdHypermediaProcessor
6+
7+
## Implements
8+
9+
* [IHypermediaProcessor](../interfaces/_src_datamodel_ihypermediaprocessor_.ihypermediaprocessor.md)
10+
11+
## Index
12+
13+
### Accessors
14+
15+
* [supportedMediaTypes](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#supportedmediatypes)
16+
17+
18+
### Methods
19+
20+
* [process](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#process)
21+
* [initialize](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#initialize)
22+
* [processArray](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#processarray)
23+
* [processHypermedia](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#processhypermedia)
24+
* [processResource](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#processresource)
25+
26+
27+
28+
29+
## Accessors
30+
<a id="supportedmediatypes"></a>
31+
32+
### supportedMediaTypes
33+
34+
35+
getsupportedMediaTypes(): Array<string>
36+
37+
*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:18](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L18)*
38+
39+
40+
41+
**Returns:** Array<string>
42+
43+
44+
45+
___
46+
47+
48+
## Methods
49+
<a id="process"></a>
50+
51+
### process
52+
53+
► **process**(response: *Response*, removeFromPayload?: *boolean*): Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
54+
55+
56+
57+
*Implementation of [IHypermediaProcessor](../interfaces/_src_datamodel_ihypermediaprocessor_.ihypermediaprocessor.md).[process](../interfaces/_src_datamodel_ihypermediaprocessor_.ihypermediaprocessor.md#process)*
58+
59+
*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:23](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L23)*
60+
61+
**Parameters:**
62+
63+
| Name | Type | Default | Description |
64+
| ------ | ------------------- | ------------ | ------------ |
65+
| response | Response | - | - |
66+
| removeFromPayload | boolean | false | - |
67+
68+
69+
70+
71+
72+
**Returns:** Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
73+
74+
75+
76+
77+
78+
___
79+
80+
<a id="initialize"></a>
81+
82+
### «Static» initialize
83+
84+
► **initialize**(): void
85+
86+
87+
88+
*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:13](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L13)*
89+
90+
91+
92+
**Returns:** void
93+
94+
95+
96+
97+
98+
___
99+
100+
<a id="processarray"></a>
101+
102+
### «Static»«Private» processArray
103+
104+
► **processArray**(payload: *any*, result: *Array<any>object*, removeFromPayload?: *boolean*): any[]object
105+
106+
107+
108+
*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:57](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L57)*
109+
110+
**Parameters:**
111+
112+
| Name | Type | Default | Description |
113+
| ------ | ------------------- | ------------ | ------------ |
114+
| payload | any | - | - |
115+
| result | Array<any>object | - | - |
116+
| removeFromPayload | boolean | false | - |
117+
118+
119+
120+
121+
122+
**Returns:** any[]object
123+
124+
125+
126+
127+
128+
___
129+
130+
<a id="processhypermedia"></a>
131+
132+
### «Static»«Private» processHypermedia
133+
134+
► **processHypermedia**(payload: *any*, result: *Array<any>object*, removeFromPayload?: *boolean*): any
135+
136+
137+
138+
*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:42](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L42)*
139+
140+
**Parameters:**
141+
142+
| Name | Type | Default | Description |
143+
| ------ | ------------------- | ------------ | ------------ |
144+
| payload | any | - | - |
145+
| result | Array<any>object | - | - |
146+
| removeFromPayload | boolean | false | - |
147+
148+
149+
150+
151+
152+
**Returns:** any
153+
154+
155+
156+
157+
158+
___
159+
160+
<a id="processresource"></a>
161+
162+
### «Static»«Private» processResource
163+
164+
► **processResource**(resource: *any*, result: *Array<any>object*, removeFromPayload: *boolean*): any
165+
166+
167+
168+
*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:81](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L81)*
169+
170+
**Parameters:**
171+
172+
| Name | Type | Default | Description |
173+
| ------ | ------------------- | ------------ | ------------ |
174+
| resource | any | - | - |
175+
| result | Array<any>object | - | - |
176+
| removeFromPayload | boolean | - | - |
177+
178+
179+
180+
181+
182+
**Returns:** any
183+
184+
185+
186+
187+
188+
___
189+
190+

0 commit comments

Comments
 (0)