@gtsc/api-models
Advanced tools
Comparing version 0.0.5-next.15 to 0.0.5-next.16
@@ -1,2 +0,2 @@ | ||
import type { HttpStatusCode } from "@gtsc/web"; | ||
import type { HeaderTypes, HttpStatusCode } from "@gtsc/web"; | ||
/** | ||
@@ -17,4 +17,4 @@ * The rest request ended in created response. | ||
*/ | ||
location: string; | ||
[HeaderTypes.Location]: string; | ||
}; | ||
} |
@@ -21,6 +21,6 @@ # Interface: ICreatedResponse | ||
#### location | ||
#### Location | ||
> **location**: `string` | ||
> **Location**: `string` | ||
The location where the resource was created. |
@@ -9,96 +9,4 @@ # Interface: IHttpRestRouteProcessor | ||
## Properties | ||
### CLASS\_NAME | ||
> `readonly` **CLASS\_NAME**: `string` | ||
The name of the component. | ||
#### Inherited from | ||
`IComponent.CLASS_NAME` | ||
## Methods | ||
### bootstrap()? | ||
> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\> | ||
Bootstrap the component by creating and initializing any resources it needs. | ||
#### Parameters | ||
• **nodeLoggingConnectorType?**: `string` | ||
The node logging connector type, defaults to "node-logging". | ||
#### Returns | ||
`Promise`\<`boolean`\> | ||
True if the bootstrapping process was successful. | ||
#### Inherited from | ||
`IComponent.bootstrap` | ||
*** | ||
### start()? | ||
> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The component needs to be started when the node is initialized. | ||
#### Parameters | ||
• **nodeIdentity**: `string` | ||
The identity of the node starting the component. | ||
• **nodeLoggingConnectorType?**: `string` | ||
The node logging connector type, defaults to "node-logging". | ||
#### Returns | ||
`Promise`\<`void`\> | ||
Nothing. | ||
#### Inherited from | ||
`IComponent.start` | ||
*** | ||
### stop()? | ||
> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The component needs to be stopped when the node is closed. | ||
#### Parameters | ||
• **nodeIdentity**: `string` | ||
The identity of the node stopping the component. | ||
• **nodeLoggingConnectorType?**: `string` | ||
The node logging connector type, defaults to "node-logging". | ||
#### Returns | ||
`Promise`\<`void`\> | ||
Nothing. | ||
#### Inherited from | ||
`IComponent.stop` | ||
*** | ||
### pre()? | ||
@@ -105,0 +13,0 @@ |
@@ -9,96 +9,4 @@ # Interface: IInformationComponent | ||
## Properties | ||
### CLASS\_NAME | ||
> `readonly` **CLASS\_NAME**: `string` | ||
The name of the component. | ||
#### Inherited from | ||
`IComponent.CLASS_NAME` | ||
## Methods | ||
### bootstrap()? | ||
> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\> | ||
Bootstrap the component by creating and initializing any resources it needs. | ||
#### Parameters | ||
• **nodeLoggingConnectorType?**: `string` | ||
The node logging connector type, defaults to "node-logging". | ||
#### Returns | ||
`Promise`\<`boolean`\> | ||
True if the bootstrapping process was successful. | ||
#### Inherited from | ||
`IComponent.bootstrap` | ||
*** | ||
### start()? | ||
> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The component needs to be started when the node is initialized. | ||
#### Parameters | ||
• **nodeIdentity**: `string` | ||
The identity of the node starting the component. | ||
• **nodeLoggingConnectorType?**: `string` | ||
The node logging connector type, defaults to "node-logging". | ||
#### Returns | ||
`Promise`\<`void`\> | ||
Nothing. | ||
#### Inherited from | ||
`IComponent.start` | ||
*** | ||
### stop()? | ||
> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The component needs to be stopped when the node is closed. | ||
#### Parameters | ||
• **nodeIdentity**: `string` | ||
The identity of the node stopping the component. | ||
• **nodeLoggingConnectorType?**: `string` | ||
The node logging connector type, defaults to "node-logging". | ||
#### Returns | ||
`Promise`\<`void`\> | ||
Nothing. | ||
#### Inherited from | ||
`IComponent.stop` | ||
*** | ||
### info() | ||
@@ -105,0 +13,0 @@ |
{ | ||
"name": "@gtsc/api-models", | ||
"version": "0.0.5-next.15", | ||
"version": "0.0.5-next.16", | ||
"description": "Contains models and classes for use with APIs", | ||
@@ -5,0 +5,0 @@ "repository": { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
997
66510