@mimik/request-helper

request-helper

Example

// default import
import requestHelper from '@mimik/request-helper';

Example

// named imports
import { getCorrelationId, getUserAgent, setUserAgent } from '@mimik/request-helper';

• request-helper
  • ~getCorrelationId([request]) ⇒ string
  • ~getUserAgent(request) ⇒ string | null
  • ~setUserAgent() ⇒ string

request-helper~getCorrelationId([request]) ⇒ string

Extract or generate a correlationId in the format uuid@step/date. Reads the x-correlation-id or X-Correlation-Id header from the request and increments the step. If no correlationId exists, generates a new one with step 0 and the current timestamp. If the step is not a number, it is reset to 0.

Kind: inner method of request-helper
Returns: string - The correlationId in uuid@step/date format.
Category: sync

Param	Type	Description
[request]	object | string	The request object with headers, or a correlationId string. Other types generate a new correlationId.

request-helper~getUserAgent(request) ⇒ string | null

Extract the user-agent header from the request.

Kind: inner method of request-helper
Returns: string | null - The user-agent string, or null if not available.
Category: sync

Param	Type	Description
request	object	The request object containing headers.

request-helper~setUserAgent() ⇒ string

Build a user-agent string identifying this server instance. Returns a string in the format mimik-type/version/id (platform; arch; runtime).

The following environment variables are optionally used:

Env variable name	Description	Default	Comments
SERVER_TYPE	type of the server instance that makes the call	genericType	for defining the agent
SERVER_VERSION	version of the server instance that makes the call	1.0	for defining the agent
SERVER_ID	id of the server instance that makes the call	generic	for defining the agent

Kind: inner method of request-helper
Returns: string - The user-agent string to be added to outgoing requests.
Category: sync