External module "error/tools/fmtprodmsg-factory/docs/types/index.d"

Index

Interfaces

Options

Type aliases

FormatProdErrorMsgFunction

Functions

fmtprodmsgFactory

Type aliases

FormatProdErrorMsgFunction

FormatProdErrorMsgFunction: (code: any, ...args: Array<any>) => string

Formats an error message for production.

param: error code
param: error message arguments
returns: formatted error message

Type declaration

- (code: any, ...args: Array<any>): string
- Parameters
  - code: any
  - Rest ...args: Array<any>
  Returns string

Functions

Export assignment fmtprodmsgFactory

fmtprodmsgFactory(options?: Options): FormatProdErrorMsgFunction

- Defined in lib/node_modules/@stdlib/error/tools/fmtprodmsg-factory/docs/types/index.d.ts:64
Returns a function which formats an error message for production.

Parameters
- Optional options: Options
  
  function options
Returns FormatProdErrorMsgFunction

error formatting function

Example
```
var opts = {
    'url': 'https://stdlib.io/error-decoder.html'
};

var fcn = factory( opts );
// returns <Function>
```