Provider

Defined in: @types/oidc-provider/index.d.ts:1517

Extends

• Application

Constructors

Constructor

new Provider(issuer, configuration?): Provider

Defined in: @types/oidc-provider/index.d.ts:1518

Parameters

issuer

string

configuration?

Configuration

Returns

Provider

Overrides

Koa.constructor

Properties

AccessToken

readonly AccessToken: typeof AccessToken

Defined in: @types/oidc-provider/index.d.ts:2182

---

app

readonly app: Application

Defined in: @types/oidc-provider/index.d.ts:1525

Deprecated

This API is no longer supported and may be removed in a future release.

---

AuthorizationCode

readonly AuthorizationCode: typeof AuthorizationCode

Defined in: @types/oidc-provider/index.d.ts:2185

---

BackchannelAuthenticationRequest

readonly BackchannelAuthenticationRequest: typeof BackchannelAuthenticationRequest

Defined in: @types/oidc-provider/index.d.ts:2190

---

BaseToken

readonly BaseToken: typeof BaseToken

Defined in: @types/oidc-provider/index.d.ts:2191

---

Client

readonly Client: typeof Client

Defined in: @types/oidc-provider/index.d.ts:2181

---

ClientCredentials

readonly ClientCredentials: typeof ClientCredentials

Defined in: @types/oidc-provider/index.d.ts:2188

---

context

context: BaseContext & DefaultContext

Defined in: @types/koa/index.d.ts:453

Inherited from

Koa.context

---

ctxStorage

ctxStorage: AsyncLocalStorage<DefaultContext> | undefined

Defined in: @types/koa/index.d.ts:458

Inherited from

Koa.ctxStorage

---

currentContext

readonly currentContext: DefaultContext | undefined

Defined in: @types/koa/index.d.ts:542

return current context from async local storage

Inherited from

Koa.currentContext

---

DeviceCode

readonly DeviceCode: typeof DeviceCode

Defined in: @types/oidc-provider/index.d.ts:2189

---

env

env: string

Defined in: @types/koa/index.d.ts:452

Inherited from

Koa.env

---

Grant

readonly Grant: typeof Grant

Defined in: @types/oidc-provider/index.d.ts:2180

---

IdToken

readonly IdToken: typeof IdToken

Defined in: @types/oidc-provider/index.d.ts:2192

---

InitialAccessToken

readonly InitialAccessToken: typeof InitialAccessToken

Defined in: @types/oidc-provider/index.d.ts:2183

---

Interaction

readonly Interaction: typeof Interaction

Defined in: @types/oidc-provider/index.d.ts:2196

---

issuer

readonly issuer: string

Defined in: @types/oidc-provider/index.d.ts:1520

---

keys

keys: string[] | Keygrip

Defined in: @types/koa/index.d.ts:457

Inherited from

Koa.keys

---

maxIpsCount

maxIpsCount: number

Defined in: @types/koa/index.d.ts:449

Inherited from

Koa.maxIpsCount

---

middleware

middleware: Middleware<DefaultState, DefaultContext, any>[]

Defined in: @types/koa/index.d.ts:450

Inherited from

Koa.middleware

---

OIDCContext

readonly OIDCContext: typeof OIDCContext

Defined in: @types/oidc-provider/index.d.ts:2194

---

proxy

proxy: boolean

Defined in: @types/koa/index.d.ts:447

Inherited from

Koa.proxy

---

proxyIpHeader

proxyIpHeader: string

Defined in: @types/koa/index.d.ts:448

Inherited from

Koa.proxyIpHeader

---

PushedAuthorizationRequest

readonly PushedAuthorizationRequest: typeof PushedAuthorizationRequest

Defined in: @types/oidc-provider/index.d.ts:2187

---

RefreshToken

readonly RefreshToken: typeof RefreshToken

Defined in: @types/oidc-provider/index.d.ts:2184

---

RegistrationAccessToken

readonly RegistrationAccessToken: typeof RegistrationAccessToken

Defined in: @types/oidc-provider/index.d.ts:2186

---

ReplayDetection

readonly ReplayDetection: typeof ReplayDetection

Defined in: @types/oidc-provider/index.d.ts:2193

---

request

request: BaseRequest

Defined in: @types/koa/index.d.ts:454

Inherited from

Koa.request

---

response

response: BaseResponse

Defined in: @types/koa/index.d.ts:455

Inherited from

Koa.response

---

Session

readonly Session: typeof Session

Defined in: @types/oidc-provider/index.d.ts:2195

---

silent

silent: boolean

Defined in: @types/koa/index.d.ts:456

Inherited from

Koa.silent

---

subdomainOffset

subdomainOffset: number

Defined in: @types/koa/index.d.ts:451

Inherited from

Koa.subdomainOffset

---

captureRejections

static captureRejections: boolean

Defined in: @types/node/events.d.ts:425

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Inherited from

Koa.captureRejections

---

captureRejectionSymbol

readonly static captureRejectionSymbol: typeof captureRejectionSymbol

Defined in: @types/node/events.d.ts:418

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Inherited from

Koa.captureRejectionSymbol

---

defaultMaxListeners

static defaultMaxListeners: number

Defined in: @types/node/events.d.ts:464

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property can be used. If this value is not a positive number, a RangeError is thrown.

Take caution when setting the events.defaultMaxListeners because the change affects all EventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a “possible EventEmitter memory leak” has been detected. For any single EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event’s name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

Inherited from

Koa.defaultMaxListeners

---

errorMonitor

readonly static errorMonitor: typeof errorMonitor

Defined in: @types/node/events.d.ts:411

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

Inherited from

Koa.errorMonitor

Accessors

ctx

Get Signature

get static ctx(): KoaContextWithOIDC | undefined

Defined in: @types/oidc-provider/index.d.ts:1527

Returns

KoaContextWithOIDC | undefined

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(error, event, …args): void

Defined in: @types/node/events.d.ts:103

Type Parameters

K

K

Parameters

error

Error

event

string | symbol

args

…AnyRest

Returns

void

Inherited from

Koa.[captureRejectionSymbol]

---

addListener()

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1562

Alias for emitter.on(eventName, listener).

Parameters

event

"access_token.destroyed"

listener

(accessToken) => void

Returns

this

Since

v0.1.26

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1563

Parameters

event

"access_token.saved"

listener

(accessToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1564

Parameters

event

"access_token.issued"

listener

(accessToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1565

Parameters

event

"authorization_code.saved"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1566

Parameters

event

"authorization_code.destroyed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1567

Parameters

event

"authorization_code.consumed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1568

Parameters

event

"device_code.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1569

Parameters

event

"device_code.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1570

Parameters

event

"device_code.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1571

Parameters

event

"backchannel_authentication_request.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1572

Parameters

event

"backchannel_authentication_request.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1576

Parameters

event

"backchannel_authentication_request.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1577

Parameters

event

"client_credentials.destroyed"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1578

Parameters

event

"client_credentials.saved"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1579

Parameters

event

"client_credentials.issued"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1580

Parameters

event

"interaction.destroyed"

listener

(interaction) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1581

Parameters

event

"interaction.saved"

listener

(interaction) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1582

Parameters

event

"session.destroyed"

listener

(session) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1583

Parameters

event

"session.saved"

listener

(session) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1584

Parameters

event

"grant.destroyed"

listener

(grant) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1585

Parameters

event

"grant.saved"

listener

(grant) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1586

Parameters

event

"replay_detection.destroyed"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1587

Parameters

event

"replay_detection.saved"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1588

Parameters

event

"pushed_authorization_request.destroyed"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1592

Parameters

event

"pushed_authorization_request.saved"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1596

Parameters

event

"registration_access_token.destroyed"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1600

Parameters

event

"registration_access_token.saved"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1604

Parameters

event

"refresh_token.destroyed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1605

Parameters

event

"refresh_token.saved"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1606

Parameters

event

"refresh_token.consumed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1607

Parameters

event

"authorization.accepted"

listener

(ctx) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1608

Parameters

event

"authorization.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1609

Parameters

event

"authorization.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1613

Parameters

event

"end_session.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1614

Parameters

event

"end_session.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1618

Parameters

event

"grant.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1619

Parameters

event

"interaction.ended"

listener

(ctx) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1620

Parameters

event

"interaction.started"

listener

(ctx, interaction) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1624

Parameters

event

"grant.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1625

Parameters

event

"grant.revoked"

listener

(ctx, grantId) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1626

Parameters

event

"backchannel.success"

listener

(ctx, client, accountId, sid) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1630

Parameters

event

"backchannel.error"

listener

(ctx, err, client, accountId, sid) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1634

Parameters

event

"pushed_authorization_request.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1635

Parameters

event

"pushed_authorization_request.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1639

Parameters

event

"registration_update.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1643

Parameters

event

"registration_update.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1647

Parameters

event

"registration_delete.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1651

Parameters

event

"registration_delete.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1655

Parameters

event

"registration_create.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1659

Parameters

event

"registration_create.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1663

Parameters

event

"introspection.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1667

Parameters

event

"registration_read.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1671

Parameters

event

"jwks.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1672

Parameters

event

"discovery.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1676

Parameters

event

"userinfo.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1680

Parameters

event

"revocation.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

Call Signature

addListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1684

Parameters

event

"server_error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.addListener

---

backchannelResult()

backchannelResult(request, result, opts?): Promise<void>

Defined in: @types/oidc-provider/index.d.ts:1529

Parameters

request

string | BackchannelAuthenticationRequest

result

string | OIDCProviderError | Grant

opts?

acr?

string

amr?

string[]

authTime?

number

Returns

Promise<void>

---

callback()

callback(): (req, res) => Promise<void>

Defined in: @types/koa/index.d.ts:520

Return a request handler callback for node’s native http/http2 server.

Returns

(req, res) => Promise<void>

Inherited from

Koa.callback

---

createContext()

createContext<StateT>(req, res): ParameterizedContext<StateT>

Defined in: @types/koa/index.d.ts:527

Initialize a new context.

Type Parameters

StateT

StateT = DefaultState

Parameters

req

IncomingMessage

res

ServerResponse

Returns

ParameterizedContext<StateT>

Api

private

Inherited from

Koa.createContext

---

emit()

emit<K>(eventName, …args): boolean

Defined in: @types/node/events.d.ts:904

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters

K

K

Parameters

eventName

string | symbol

args

…AnyRest

Returns

boolean

Since

v0.1.26

Inherited from

Koa.emit

---

eventNames()

eventNames(): (string | symbol)[]

Defined in: @types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

Koa.eventNames

---

getMaxListeners()

getMaxListeners(): number

Defined in: @types/node/events.d.ts:819

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

Koa.getMaxListeners

---

inspect()

inspect(): any

Defined in: @types/koa/index.d.ts:499

Return JSON representation. We only bother showing settings.

Returns

any

Inherited from

Koa.inspect

---

interactionDetails()

interactionDetails(req, res): Promise<Interaction>

Defined in: @types/oidc-provider/index.d.ts:1549

Parameters

req

IncomingMessage | Http2ServerRequest

res

ServerResponse<IncomingMessage> | Http2ServerResponse<Http2ServerRequest>

Returns

Promise<Interaction>

---

interactionFinished()

interactionFinished(req, res, result, options?): Promise<void>

Defined in: @types/oidc-provider/index.d.ts:1542

Parameters

req

IncomingMessage | Http2ServerRequest

res

ServerResponse<IncomingMessage> | Http2ServerResponse<Http2ServerRequest>

result

InteractionResults

options?

mergeWithLastSubmission?

boolean

Returns

Promise<void>

---

interactionResult()

interactionResult(req, res, result, options?): Promise<string>

Defined in: @types/oidc-provider/index.d.ts:1535

Parameters

req

IncomingMessage | Http2ServerRequest

res

ServerResponse<IncomingMessage> | Http2ServerResponse<Http2ServerRequest>

result

InteractionResults

options?

mergeWithLastSubmission?

boolean

Returns

Promise<string>

---

listen()

Call Signature

listen(port?, hostname?, backlog?, listeningListener?): Server

Defined in: @types/koa/index.d.ts:485

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

port?

number

hostname?

string

backlog?

number

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(port, hostname?, listeningListener?): Server

Defined in: @types/koa/index.d.ts:486

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

port

number

hostname?

string

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(port, backlog?, listeningListener?): Server

Defined in: @types/koa/index.d.ts:487

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

port

number

backlog?

number

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(port, listeningListener?): Server

Defined in: @types/koa/index.d.ts:488

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

port

number

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(path, backlog?, listeningListener?): Server

Defined in: @types/koa/index.d.ts:489

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

path

string

backlog?

number

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(path, listeningListener?): Server

Defined in: @types/koa/index.d.ts:490

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

path

string

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(options, listeningListener?): Server

Defined in: @types/koa/index.d.ts:491

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

options

ListenOptions

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(handle, backlog?, listeningListener?): Server

Defined in: @types/koa/index.d.ts:492

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

handle

any

backlog?

number

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

Call Signature

listen(handle, listeningListener?): Server

Defined in: @types/koa/index.d.ts:493

Shorthand for:

http.createServer(app.callback()).listen(…)

Parameters

handle

any

listeningListener?

() => void

Returns

Server

Inherited from

Koa.listen

---

listenerCount()

listenerCount<K>(eventName, listener?): number

Defined in: @types/node/events.d.ts:913

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event being listened for

listener?

Function

The event handler function

Returns

number

Since

v3.2.0

Inherited from

Koa.listenerCount

---

listeners()

listeners<K>(eventName): Function[]

Defined in: @types/node/events.d.ts:832

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

Koa.listeners

---

off()

off<K>(eventName, listener): this

Defined in: @types/node/events.d.ts:792

Alias for emitter.removeListener().

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v10.0.0

Inherited from

Koa.off

---

on()

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1686

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

event

"access_token.destroyed"

listener

(accessToken) => void

The callback function

Returns

this

Since

v0.1.101

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1687

Parameters

event

"access_token.saved"

listener

(accessToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1688

Parameters

event

"access_token.issued"

listener

(accessToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1689

Parameters

event

"authorization_code.saved"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1690

Parameters

event

"authorization_code.destroyed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1691

Parameters

event

"authorization_code.consumed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1692

Parameters

event

"device_code.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1693

Parameters

event

"device_code.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1694

Parameters

event

"device_code.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1695

Parameters

event

"backchannel_authentication_request.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1696

Parameters

event

"backchannel_authentication_request.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1697

Parameters

event

"backchannel_authentication_request.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1698

Parameters

event

"client_credentials.destroyed"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1699

Parameters

event

"client_credentials.saved"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1700

Parameters

event

"client_credentials.issued"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1701

Parameters

event

"interaction.destroyed"

listener

(interaction) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1702

Parameters

event

"interaction.saved"

listener

(interaction) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1703

Parameters

event

"session.destroyed"

listener

(session) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1704

Parameters

event

"session.saved"

listener

(session) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1705

Parameters

event

"grant.destroyed"

listener

(grant) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1706

Parameters

event

"grant.saved"

listener

(grant) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1707

Parameters

event

"replay_detection.destroyed"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1708

Parameters

event

"replay_detection.saved"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1709

Parameters

event

"pushed_authorization_request.destroyed"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1713

Parameters

event

"pushed_authorization_request.saved"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1717

Parameters

event

"registration_access_token.destroyed"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1721

Parameters

event

"registration_access_token.saved"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1725

Parameters

event

"refresh_token.destroyed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1726

Parameters

event

"refresh_token.saved"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1727

Parameters

event

"refresh_token.consumed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1728

Parameters

event

"authorization.accepted"

listener

(ctx) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1729

Parameters

event

"authorization.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1730

Parameters

event

"authorization.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1731

Parameters

event

"end_session.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1732

Parameters

event

"end_session.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1733

Parameters

event

"grant.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1734

Parameters

event

"interaction.ended"

listener

(ctx) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1735

Parameters

event

"interaction.started"

listener

(ctx, interaction) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1736

Parameters

event

"grant.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1737

Parameters

event

"grant.revoked"

listener

(ctx, grantId) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1738

Parameters

event

"backchannel.success"

listener

(ctx, client, accountId, sid) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1742

Parameters

event

"backchannel.error"

listener

(ctx, err, client, accountId, sid) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1746

Parameters

event

"pushed_authorization_request.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1747

Parameters

event

"pushed_authorization_request.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1751

Parameters

event

"registration_update.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1752

Parameters

event

"registration_update.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1756

Parameters

event

"registration_delete.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1757

Parameters

event

"registration_delete.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1761

Parameters

event

"registration_create.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1762

Parameters

event

"registration_create.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1766

Parameters

event

"introspection.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1767

Parameters

event

"registration_read.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1771

Parameters

event

"jwks.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1772

Parameters

event

"discovery.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1773

Parameters

event

"userinfo.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1774

Parameters

event

"revocation.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

Call Signature

on(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1775

Parameters

event

"server_error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.on

---

once()

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1777

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

event

"access_token.destroyed"

listener

(accessToken) => void

The callback function

Returns

this

Since

v0.3.0

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1778

Parameters

event

"access_token.saved"

listener

(accessToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1779

Parameters

event

"access_token.issued"

listener

(accessToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1780

Parameters

event

"authorization_code.saved"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1781

Parameters

event

"authorization_code.destroyed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1782

Parameters

event

"authorization_code.consumed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1783

Parameters

event

"device_code.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1784

Parameters

event

"device_code.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1785

Parameters

event

"device_code.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1786

Parameters

event

"backchannel_authentication_request.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1787

Parameters

event

"backchannel_authentication_request.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1788

Parameters

event

"backchannel_authentication_request.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1789

Parameters

event

"client_credentials.destroyed"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1790

Parameters

event

"client_credentials.saved"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1791

Parameters

event

"client_credentials.issued"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1792

Parameters

event

"interaction.destroyed"

listener

(interaction) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1793

Parameters

event

"interaction.saved"

listener

(interaction) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1794

Parameters

event

"session.destroyed"

listener

(session) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1795

Parameters

event

"session.saved"

listener

(session) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1796

Parameters

event

"grant.destroyed"

listener

(grant) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1797

Parameters

event

"grant.saved"

listener

(grant) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1798

Parameters

event

"replay_detection.destroyed"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1799

Parameters

event

"replay_detection.saved"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1800

Parameters

event

"pushed_authorization_request.destroyed"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1804

Parameters

event

"pushed_authorization_request.saved"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1808

Parameters

event

"registration_access_token.destroyed"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1812

Parameters

event

"registration_access_token.saved"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1816

Parameters

event

"refresh_token.destroyed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1817

Parameters

event

"refresh_token.saved"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1818

Parameters

event

"refresh_token.consumed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1819

Parameters

event

"authorization.accepted"

listener

(ctx) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1820

Parameters

event

"authorization.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1821

Parameters

event

"authorization.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1825

Parameters

event

"end_session.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1826

Parameters

event

"end_session.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1827

Parameters

event

"grant.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1828

Parameters

event

"interaction.ended"

listener

(ctx) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1829

Parameters

event

"interaction.started"

listener

(ctx, interaction) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1830

Parameters

event

"grant.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1831

Parameters

event

"grant.revoked"

listener

(ctx, grantId) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1832

Parameters

event

"backchannel.success"

listener

(ctx, client, accountId, sid) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1836

Parameters

event

"backchannel.error"

listener

(ctx, err, client, accountId, sid) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1840

Parameters

event

"pushed_authorization_request.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1841

Parameters

event

"pushed_authorization_request.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1845

Parameters

event

"registration_update.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1846

Parameters

event

"registration_update.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1850

Parameters

event

"registration_delete.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1851

Parameters

event

"registration_delete.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1855

Parameters

event

"registration_create.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1856

Parameters

event

"registration_create.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1860

Parameters

event

"introspection.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1864

Parameters

event

"registration_read.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1868

Parameters

event

"jwks.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1869

Parameters

event

"discovery.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1870

Parameters

event

"userinfo.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1871

Parameters

event

"revocation.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

Call Signature

once(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1872

Parameters

event

"server_error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.once

---

onerror()

onerror(err): void

Defined in: @types/koa/index.d.ts:537

Default error handler.

Parameters

err

Error

Returns

void

Api

private

Inherited from

Koa.onerror

---

prependListener()

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1874

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

event

"access_token.destroyed"

listener

(accessToken) => void

The callback function

Returns

this

Since

v6.0.0

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1875

Parameters

event

"access_token.saved"

listener

(accessToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1876

Parameters

event

"access_token.issued"

listener

(accessToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1877

Parameters

event

"authorization_code.saved"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1878

Parameters

event

"authorization_code.destroyed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1882

Parameters

event

"authorization_code.consumed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1886

Parameters

event

"device_code.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1887

Parameters

event

"device_code.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1888

Parameters

event

"device_code.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1889

Parameters

event

"backchannel_authentication_request.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1893

Parameters

event

"backchannel_authentication_request.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1897

Parameters

event

"backchannel_authentication_request.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1901

Parameters

event

"client_credentials.destroyed"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1905

Parameters

event

"client_credentials.saved"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1906

Parameters

event

"client_credentials.issued"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1907

Parameters

event

"interaction.destroyed"

listener

(interaction) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1908

Parameters

event

"interaction.saved"

listener

(interaction) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1909

Parameters

event

"session.destroyed"

listener

(session) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1910

Parameters

event

"session.saved"

listener

(session) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1911

Parameters

event

"grant.destroyed"

listener

(grant) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1912

Parameters

event

"grant.saved"

listener

(grant) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1913

Parameters

event

"replay_detection.destroyed"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1914

Parameters

event

"replay_detection.saved"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1915

Parameters

event

"pushed_authorization_request.destroyed"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1919

Parameters

event

"pushed_authorization_request.saved"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1923

Parameters

event

"registration_access_token.destroyed"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1927

Parameters

event

"registration_access_token.saved"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1931

Parameters

event

"refresh_token.destroyed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1932

Parameters

event

"refresh_token.saved"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1933

Parameters

event

"refresh_token.consumed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1934

Parameters

event

"authorization.accepted"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1935

Parameters

event

"authorization.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1936

Parameters

event

"authorization.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1940

Parameters

event

"end_session.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1941

Parameters

event

"end_session.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1945

Parameters

event

"grant.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1946

Parameters

event

"interaction.ended"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1947

Parameters

event

"interaction.started"

listener

(ctx, interaction) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1951

Parameters

event

"grant.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1955

Parameters

event

"grant.revoked"

listener

(ctx, grantId) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1956

Parameters

event

"backchannel.success"

listener

(ctx, client, accountId, sid) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1960

Parameters

event

"backchannel.error"

listener

(ctx, err, client, accountId, sid) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1964

Parameters

event

"pushed_authorization_request.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1965

Parameters

event

"pushed_authorization_request.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1969

Parameters

event

"registration_update.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1973

Parameters

event

"registration_update.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1977

Parameters

event

"registration_delete.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1981

Parameters

event

"registration_delete.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1985

Parameters

event

"registration_create.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1989

Parameters

event

"registration_create.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1993

Parameters

event

"introspection.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:1997

Parameters

event

"registration_read.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2001

Parameters

event

"jwks.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2005

Parameters

event

"discovery.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2009

Parameters

event

"userinfo.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2013

Parameters

event

"revocation.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

Call Signature

prependListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2017

Parameters

event

"server_error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependListener

---

prependOnceListener()

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2019

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

event

"access_token.destroyed"

listener

(accessToken) => void

The callback function

Returns

this

Since

v6.0.0

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2020

Parameters

event

"access_token.saved"

listener

(accessToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2021

Parameters

event

"access_token.issued"

listener

(accessToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2022

Parameters

event

"authorization_code.saved"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2026

Parameters

event

"authorization_code.destroyed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2030

Parameters

event

"authorization_code.consumed"

listener

(authorizationCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2034

Parameters

event

"device_code.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2035

Parameters

event

"device_code.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2036

Parameters

event

"device_code.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2037

Parameters

event

"backchannel_authentication_request.saved"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2041

Parameters

event

"backchannel_authentication_request.destroyed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2045

Parameters

event

"backchannel_authentication_request.consumed"

listener

(deviceCode) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2049

Parameters

event

"client_credentials.destroyed"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2053

Parameters

event

"client_credentials.saved"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2057

Parameters

event

"client_credentials.issued"

listener

(clientCredentials) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2061

Parameters

event

"interaction.destroyed"

listener

(interaction) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2062

Parameters

event

"interaction.saved"

listener

(interaction) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2063

Parameters

event

"session.destroyed"

listener

(session) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2064

Parameters

event

"session.saved"

listener

(session) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2065

Parameters

event

"grant.destroyed"

listener

(grant) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2066

Parameters

event

"grant.saved"

listener

(grant) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2067

Parameters

event

"replay_detection.destroyed"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2071

Parameters

event

"replay_detection.saved"

listener

(replayDetection) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2072

Parameters

event

"pushed_authorization_request.destroyed"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2076

Parameters

event

"pushed_authorization_request.saved"

listener

(pushedAuthorizationRequest) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2080

Parameters

event

"registration_access_token.destroyed"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2084

Parameters

event

"registration_access_token.saved"

listener

(registrationAccessToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2088

Parameters

event

"refresh_token.destroyed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2089

Parameters

event

"refresh_token.saved"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2090

Parameters

event

"refresh_token.consumed"

listener

(refreshToken) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2091

Parameters

event

"authorization.accepted"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2092

Parameters

event

"authorization.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2093

Parameters

event

"authorization.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2097

Parameters

event

"end_session.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2098

Parameters

event

"end_session.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2102

Parameters

event

"grant.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2103

Parameters

event

"interaction.ended"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2104

Parameters

event

"interaction.started"

listener

(ctx, interaction) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2108

Parameters

event

"grant.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2112

Parameters

event

"grant.revoked"

listener

(ctx, grantId) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2113

Parameters

event

"backchannel.success"

listener

(ctx, client, accountId, sid) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2117

Parameters

event

"backchannel.error"

listener

(ctx, err, client, accountId, sid) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2121

Parameters

event

"pushed_authorization_request.success"

listener

(ctx) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2125

Parameters

event

"pushed_authorization_request.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2129

Parameters

event

"registration_update.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2133

Parameters

event

"registration_update.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2137

Parameters

event

"registration_delete.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2141

Parameters

event

"registration_delete.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2145

Parameters

event

"registration_create.success"

listener

(ctx, client) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2149

Parameters

event

"registration_create.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2153

Parameters

event

"introspection.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2157

Parameters

event

"registration_read.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2161

Parameters

event

"jwks.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2165

Parameters

event

"discovery.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2169

Parameters

event

"userinfo.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2173

Parameters

event

"revocation.error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: @types/oidc-provider/index.d.ts:2177

Parameters

event

"server_error"

listener

(ctx, err) => void

Returns

this

Overrides

Koa.prependOnceListener

---

rawListeners()

rawListeners<K>(eventName): Function[]

Defined in: @types/node/events.d.ts:863

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

Koa.rawListeners

---

registerGrantType()

registerGrantType(name, handler, params?, duplicates?): void

Defined in: @types/oidc-provider/index.d.ts:1554

Parameters

name

string

handler

(ctx, next) => CanBePromise<void>

params?

string | string[] | Set<string>

duplicates?

string | string[] | Set<string>

Returns

void

---

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: @types/node/events.d.ts:803

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

eventName?

string | symbol

Returns

this

Since

v0.1.26

Inherited from

Koa.removeAllListeners

---

removeListener()

removeListener<K>(eventName, listener): this

Defined in: @types/node/events.d.ts:787

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

Koa.removeListener

---

setMaxListeners()

setMaxListeners(n): this

Defined in: @types/node/events.d.ts:813

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

n

number

Returns

this

Since

v0.3.5

Inherited from

Koa.setMaxListeners

---

toJSON()

toJSON(): any

Defined in: @types/koa/index.d.ts:505

Return JSON representation. We only bother showing settings.

Returns

any

Inherited from

Koa.toJSON

---

use()

use<NewStateT, NewContextT>(middleware): Application<DefaultState & NewStateT, DefaultContext & NewContextT>

Defined in: @types/koa/index.d.ts:512

Use the given middleware fn.

Old-style middleware will be converted.

Type Parameters

NewStateT

NewStateT = { }

NewContextT

NewContextT = { }

Parameters

middleware

Middleware<DefaultState & NewStateT, DefaultContext & NewContextT>

Returns

Application<DefaultState & NewStateT, DefaultContext & NewContextT>

Inherited from

Koa.use

---

addAbortListener()

static addAbortListener(signal, resource): Disposable

Defined in: @types/node/events.d.ts:403

Listens once to the abort event on the provided signal.

Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.

This API allows safely using AbortSignals in Node.js APIs by solving these two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

Returns a disposable so that it may be unsubscribed from more easily.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}

Parameters

signal

AbortSignal

resource

(event) => void

Returns

Disposable

Disposable that removes the abort listener.

Since

v20.5.0

Inherited from

Koa.addAbortListener

---

getEventListeners()

static getEventListeners(emitter, name): Function[]

Defined in: @types/node/events.d.ts:325

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}

Parameters

emitter

EventTarget | EventEmitter<DefaultEventMap>

name

string | symbol

Returns

Function[]

Since

v15.2.0, v14.17.0

Inherited from

Koa.getEventListeners

---

getMaxListeners()

static getMaxListeners(emitter): number

Defined in: @types/node/events.d.ts:354

Returns the currently set max amount of listeners.

For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}

Parameters

emitter

EventTarget | EventEmitter<DefaultEventMap>

Returns

number

Since

v19.9.0

Inherited from

Koa.getMaxListeners

---

listenerCount()

static listenerCount(emitter, eventName): number

Defined in: @types/node/events.d.ts:297

A class method that returns the number of listeners for the given eventName registered on the given emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Deprecated

Since v3.2.0 - Use listenerCount instead.

Parameters

emitter

EventEmitter

The emitter to query

eventName

string | symbol

The event name

Returns

number

Since

v0.9.12

Inherited from

Koa.listenerCount

---

on()

Call Signature

static on(emitter, eventName, options?): AsyncIterator<any[]>

Defined in: @types/node/events.d.ts:270

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

emitter

EventEmitter

eventName

string | symbol

options?

StaticEventEmitterIteratorOptions

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

Koa.on

Call Signature

static on(emitter, eventName, options?): AsyncIterator<any[]>

Defined in: @types/node/events.d.ts:275

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

emitter

EventTarget

eventName

string

options?

StaticEventEmitterIteratorOptions

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

Koa.on

---

once()

Call Signature

static once(emitter, eventName, options?): Promise<any[]>

Defined in: @types/node/events.d.ts:184

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the ‘error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

emitter

EventEmitter

eventName

string | symbol

options?

StaticEventEmitterOptions

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

Koa.once

Call Signature

static once(emitter, eventName, options?): Promise<any[]>

Defined in: @types/node/events.d.ts:189

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the ‘error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

emitter

EventTarget

eventName

string

options?

StaticEventEmitterOptions

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

Koa.once

---

setMaxListeners()

static setMaxListeners(n?, …eventTargets): void

Defined in: @types/node/events.d.ts:369

import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

n?

number

A non-negative number. The maximum number of listeners per EventTarget event.

eventTargets

…(EventTarget | EventEmitter<DefaultEventMap>)[]

Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

Returns

void

Since

v15.4.0

Inherited from

Koa.setMaxListeners