Class Targets

Exposes the API to construct targets array conditionally.

Index

Constructors

Methods

push pushIf pushUnless toArray

Constructors

constructor

new Targets(): Targets
Returns Targets

Methods

push

push(value: TransportTargetOptions): this
Add target to the list of targets
Parameters
- value: TransportTargetOptions
  The transport target options to add
Returns this
The current Targets instance for chaining
- Defined in src/targets/create.ts:26

pushIf

pushIf(
    conditional: boolean,
    value:
        | TransportTargetOptions<Record<string, any>>
        | (() => TransportTargetOptions),
): this
Conditionally add target to the list targets. The target will only be added if the conditional is true.
```
targets.if(process.env.NODE_ENV === 'development', {
  target: 'pino-pretty'
})
```
Parameters
- conditional: boolean
  Condition to check before adding the target
- value: TransportTargetOptions<Record<string, any>> | (() => TransportTargetOptions)
  The transport target options or factory function
Returns this
The current Targets instance for chaining
- Defined in src/targets/create.ts:44

pushUnless

pushUnless(
    conditional: boolean,
    value:
        | TransportTargetOptions<Record<string, any>>
        | (() => TransportTargetOptions),
): this
Conditionally add target to the list targets. The target will only be added unless the conditional is true.
```
targets.unless(process.env.NODE_ENV === 'production', {
  target: 'pino-pretty'
})
```
Parameters
- conditional: boolean
  Condition to check before adding the target
- value: TransportTargetOptions<Record<string, any>> | (() => TransportTargetOptions)
  The transport target options or factory function
Returns this
The current Targets instance for chaining
- Defined in src/targets/create.ts:68

toArray

toArray(): TransportTargetOptions<Record<string, any>>[]
Get targets array

Returns TransportTargetOptions<Record<string, any>>[]
Array of transport target options
- Defined in src/targets/create.ts:83