Promise.<WhookHTTPTransaction>Instantiate the httpTransaction service
stringPick the first header value if exists
ArrayPick header values
Promise.<Object>Application monitoring service that simply log stringified contents.
Promise.<Object>Obfuscate sensible informations.
Promise.<WhookHTTPTransaction>](#WhookHTTPTransaction)
Instantiate the httpTransaction service
**Kind**: global function
**Returns**: [Promise.<WhookHTTPTransaction>](#WhookHTTPTransaction) - A promise of the httpTransaction function
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The services to inject |
| [services.TIMEOUT] | Number | 30000 | A number indicating how many ms the transaction should take to complete before being cancelled. |
| [services.TRANSACTIONS] | Object | {} | A hash of every current transactions |
| services.delay | Object | | A delaying service |
| services.obfuscator | Object | | A service to avoid logging sensible informations |
| [services.log] | function | | A logging function |
| [services.apm] | function | | An apm function |
| [services.time] | function | | A timing function |
| [services.uniqueId] | function | | A function returning unique identifiers |
**Example**
```js
import initHTTPTransaction from '@whook/http-transaction';
import { log } from 'node:console';
const httpTransaction = await initHTTPTransaction({
log,
time: Date.now.bind(Date),
});
```
### initHTTPTransaction~httpTransaction(req, res) ⇒ Array
Create a new HTTP transaction
**Kind**: inner method of [initHTTPTransaction](#initHTTPTransaction)
**Returns**: Array - The normalized request and the HTTP
transaction created in an array.
| Param | Type | Description |
| --- | --- | --- |
| req | HTTPRequest | A raw NodeJS HTTP incoming message |
| res | HTTPResponse | A raw NodeJS HTTP response |
## pickFirstHeaderValue(name, headers) ⇒ string
Pick the first header value if exists
**Kind**: global function
**Returns**: string - The value if defined.
| Param | Type | Description |
| --- | --- | --- |
| name | string | The header name |
| headers | Object | The headers map |
## pickAllHeaderValues(name, headers) ⇒ Array
Pick header values
**Kind**: global function
**Returns**: Array - The values in an array.
| Param | Type | Description |
| --- | --- | --- |
| name | string | The header name |
| headers | Object | The headers map |
## initAPM(services) ⇒ Promise.<Object>
Application monitoring service that simply log stringified contents.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of the apm service.
| Param | Type | Description |
| --- | --- | --- |
| services | Object | The services to inject |
| [services.log] | function | A logging function |
## initObfuscator(services) ⇒ Promise.<Object>
Obfuscate sensible informations.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of an object containing the gathered constants.
| Param | Type | Description |
| --- | --- | --- |
| services | Object | The service dependend on |
| [services.SHIELD_CHAR] | Object | The char for replacing sensible informations |
| [services.MAX_CLEAR_CHARS] | Object | The maximum clear chars to display |
| [services.MAX_CLEAR_RATIO] | Object | The maximum clear chars ratio to display |
| [services.SENSIBLE_PROPS] | Object | Sensible properties names |
| [services.SENSIBLE_HEADERS] | Object | Sensible headers names |
**Example**
```js
import { initObfuscator } from '@whook/http-transaction';
import { alsoInject } from 'knifecycle';
import { log } from 'node:console';
const obfuscator = await initObfuscator();
log(obfuscator('my very secret information!));
// my ...on!
```
## WhookHTTPTransaction
**Kind**: global typedef
* [WhookHTTPTransaction](#WhookHTTPTransaction)
* [.id](#WhookHTTPTransaction.id)
* [.start](#WhookHTTPTransaction.start) ⇒ Promise.<Object>
* [.catch](#WhookHTTPTransaction.catch) ⇒ Promise
* [.end](#WhookHTTPTransaction.end) ⇒ Promise.<Object>
### WhookHTTPTransaction.id
Id of the transaction
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
### WhookHTTPTransaction.start ⇒ Promise.<Object>
Start the transaction
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
**Returns**: Promise.<Object> - A promise to be resolved with the signed token.
| Param | Type | Description |
| --- | --- | --- |
| buildResponse | function | A function that builds a response |
### WhookHTTPTransaction.catch ⇒ Promise
Catch a transaction error
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
**Returns**: Promise - A promise to be resolved with the signed token.
| Param | Type | Description |
| --- | --- | --- |
| err | Error | A function that builds a response |
### WhookHTTPTransaction.end ⇒ Promise.<Object>
End the transaction
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
**Returns**: Promise.<Object> - A promise to be resolved with the signed token.
| Param | Type | Description |
| --- | --- | --- |
| response | Object | A response for the transaction |
# Authors
- [Nicolas Froidure](http://insertafter.com/en/index.html)
# License
[MIT](https://github.com/nfroidure/whook/blob/main/packages/whook-http-transaction/LICENSE)
---
_Source: https://npm.io/package/@whook/http-transaction · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._