Reference client kick-off

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.idea
+.vs
+bin

doc/classes/_src_apidocumentation_.apidocumentation.md

@@ -0,0 +1,163 @@
+[hydraclient.js](../index.md) > ["src/ApiDocumentation"](../modules/_src_apidocumentation_.md) > [ApiDocumentation](../classes/_src_apidocumentation_.apidocumentation.md)
+
+
+
+# Class: ApiDocumentation
+
+## Implements
+
+* [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md)
+
+## Index
+
+### Properties
+
+* [client](_src_apidocumentation_.apidocumentation.md#client)
+* [description](_src_apidocumentation_.apidocumentation.md#description)
+* [entryPoint](_src_apidocumentation_.apidocumentation.md#entrypoint)
+* [supportedClasses](_src_apidocumentation_.apidocumentation.md#supportedclasses)
+* [supportedOperations](_src_apidocumentation_.apidocumentation.md#supportedoperations)
+* [title](_src_apidocumentation_.apidocumentation.md#title)
+
+
+### Methods
+
+* [ApiDocumentation](_src_apidocumentation_.apidocumentation.md#apidocumentation)
+* [getEntryPoint](_src_apidocumentation_.apidocumentation.md#getentrypoint)
+
+
+
+## Properties
+<a id="client"></a>
+
+###  client
+
+**client**:  *[HydraClient](_src_hydraclient_.hydraclient.md)* 
+
+*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[client](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#client)*
+
+*Defined in [src/ApiDocumentation.ts:19](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L19)*
+
+
+
+
+___
+
+<a id="description"></a>
+
+### «Optional» description
+
+**description**:  *string* 
+
+*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[description](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#description)*
+
+*Defined in [src/ApiDocumentation.ts:11](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L11)*
+
+
+
+
+___
+
+<a id="entrypoint"></a>
+
+###  entryPoint
+
+**entryPoint**:  *string* 
+
+*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[entryPoint](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#entrypoint)*
+
+*Defined in [src/ApiDocumentation.ts:17](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L17)*
+
+
+
+
+___
+
+<a id="supportedclasses"></a>
+
+###  supportedClasses
+
+**supportedClasses**:  *Array<[IClass](../interfaces/_src_datamodel_iclass_.iclass.md)>* 
+
+*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[supportedClasses](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#supportedclasses)*
+
+*Defined in [src/ApiDocumentation.ts:13](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L13)*
+
+
+
+
+___
+
+<a id="supportedoperations"></a>
+
+###  supportedOperations
+
+**supportedOperations**:  *Array<[IOperation](../interfaces/_src_datamodel_ioperation_.ioperation.md)>* 
+
+*Defined in [src/ApiDocumentation.ts:15](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L15)*
+
+
+
+
+___
+
+<a id="title"></a>
+
+### «Optional» title
+
+**title**:  *string* 
+
+*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[title](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#title)*
+
+*Defined in [src/ApiDocumentation.ts:9](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L9)*
+
+
+
+
+___
+
+
+## Methods
+<a id="apidocumentation"></a>
+
+###  ApiDocumentation
+
+► **ApiDocumentation**(): void
+
+
+
+*Defined in [src/ApiDocumentation.ts:21](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L21)*
+
+
+
+**Returns:** void
+
+
+
+
+
+___
+
+<a id="getentrypoint"></a>
+
+###  getEntryPoint
+
+► **getEntryPoint**(): Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
+
+
+
+*Implementation of [IApiDocumentation](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md).[getEntryPoint](../interfaces/_src_datamodel_iapidocumentation_.iapidocumentation.md#getentrypoint)*
+
+*Defined in [src/ApiDocumentation.ts:28](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/ApiDocumentation.ts#L28)*
+
+
+
+**Returns:** Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
+
+
+
+
+
+___
+
+

doc/classes/_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md

@@ -0,0 +1,190 @@
+[hydraclient.js](../index.md) > ["src/DataModel/JsonLd/JsonLdHypermediaProcessor"](../modules/_src_datamodel_jsonld_jsonldhypermediaprocessor_.md) > [JsonLdHypermediaProcessor](../classes/_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md)
+
+
+
+# Class: JsonLdHypermediaProcessor
+
+## Implements
+
+* [IHypermediaProcessor](../interfaces/_src_datamodel_ihypermediaprocessor_.ihypermediaprocessor.md)
+
+## Index
+
+### Accessors
+
+* [supportedMediaTypes](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#supportedmediatypes)
+
+
+### Methods
+
+* [process](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#process)
+* [initialize](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#initialize)
+* [processArray](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#processarray)
+* [processHypermedia](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#processhypermedia)
+* [processResource](_src_datamodel_jsonld_jsonldhypermediaprocessor_.jsonldhypermediaprocessor.md#processresource)
+
+
+
+
+## Accessors
+<a id="supportedmediatypes"></a>
+
+###  supportedMediaTypes
+
+
+getsupportedMediaTypes(): Array<string>
+
+*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:18](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L18)*
+
+
+
+**Returns:** Array<string>
+
+
+
+___
+
+
+## Methods
+<a id="process"></a>
+
+###  process
+
+► **process**(response: *Response*, removeFromPayload?: *boolean*): Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
+
+
+
+*Implementation of [IHypermediaProcessor](../interfaces/_src_datamodel_ihypermediaprocessor_.ihypermediaprocessor.md).[process](../interfaces/_src_datamodel_ihypermediaprocessor_.ihypermediaprocessor.md#process)*
+
+*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:23](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L23)*
+
+**Parameters:**
+
+| Name  | Type                | Default | Description  |
+| ------ | ------------------- | ------------ | ------------ |
+| response  | Response | - | - |
+| removeFromPayload  | boolean | false | - |
+
+
+
+
+
+**Returns:** Promise<[IWebResource](../interfaces/_src_datamodel_iwebresource_.iwebresource.md)>
+
+
+
+
+
+___
+
+<a id="initialize"></a>
+
+### «Static» initialize
+
+► **initialize**(): void
+
+
+
+*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:13](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L13)*
+
+
+
+**Returns:** void
+
+
+
+
+
+___
+
+<a id="processarray"></a>
+
+### «Static»«Private» processArray
+
+► **processArray**(payload: *any*, result: *Array<any>object*, removeFromPayload?: *boolean*): any[]object
+
+
+
+*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:57](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L57)*
+
+**Parameters:**
+
+| Name  | Type                | Default | Description  |
+| ------ | ------------------- | ------------ | ------------ |
+| payload  | any | - | - |
+| result  | Array<any>object | - | - |
+| removeFromPayload  | boolean | false | - |
+
+
+
+
+
+**Returns:** any[]object
+
+
+
+
+
+___
+
+<a id="processhypermedia"></a>
+
+### «Static»«Private» processHypermedia
+
+► **processHypermedia**(payload: *any*, result: *Array<any>object*, removeFromPayload?: *boolean*): any
+
+
+
+*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:42](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L42)*
+
+**Parameters:**
+
+| Name  | Type                | Default | Description  |
+| ------ | ------------------- | ------------ | ------------ |
+| payload  | any | - | - |
+| result  | Array<any>object | - | - |
+| removeFromPayload  | boolean | false | - |
+
+
+
+
+
+**Returns:** any
+
+
+
+
+
+___
+
+<a id="processresource"></a>
+
+### «Static»«Private» processResource
+
+► **processResource**(resource: *any*, result: *Array<any>object*, removeFromPayload: *boolean*): any
+
+
+
+*Defined in [src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts:81](https://github.com/alien-mcl/Heracles.ts/blob/80e3949/src/DataModel/JsonLd/JsonLdHypermediaProcessor.ts#L81)*
+
+**Parameters:**
+
+| Name  | Type                | Default | Description  |
+| ------ | ------------------- | ------------ | ------------ |
+| resource  | any | - | - |
+| result  | Array<any>object | - | - |
+| removeFromPayload  | boolean | - | - |
+
+
+
+
+
+**Returns:** any
+
+
+
+
+
+___
+
+