@inrupt/solid-client-authn-browser / ISessionEventListener
Interface: ISessionEventListener#
Hierarchy#
EventEmitter
↳
ISessionEventListener
Methods#
[captureRejectionSymbol]#
▸ [captureRejectionSymbol](error
, event
, ...args
): void
Parameters#
Name |
Type |
---|---|
|
|
|
|
|
|
Returns#
void
Inherited from#
EventEmitter.[captureRejectionSymbol]
Defined in#
node_modules/@types/node/events.d.ts:112
addListener#
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called on successful login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The login event name |
|
() => |
The callback called on successful login |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:103
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called on successful logout.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The logout event name. |
|
() => |
The callback called on successful logout. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:109
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called on session expiration.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session expiration event name. |
|
() => |
The callback called on session expiration. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:115
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called on session restoration after a silent login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session restoration event name. |
|
( |
The callback called on successful session restore. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:121
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called on error, with an error identifier and description.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The error event name. |
|
( |
The callback called on error. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:127
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called on session extension.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session extension event name. |
|
( |
The callback called on session extension. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:133
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called when a timeout is set for a session event with the timeout handle.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The timeout set event name. |
|
( |
The callback called when setting a timeout. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:140
▸ addListener(eventName
, listener
): ISessionEventListener
Register a listener called when a new refresh token is issued for the session.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The new refresh token issued event name. |
|
( |
The callback called when a new refresh token is issued. |
Returns#
Overrides#
EventEmitter.addListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:146
eventNames#
▸ eventNames(): (string
| symbol
)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbol
s.
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#
EventEmitter.eventNames
Defined in#
node_modules/@types/node/events.d.ts:870
getMaxListeners#
▸ getMaxListeners(): number
Returns the current max listener value for the EventEmitter
which is either
set by emitter.setMaxListeners(n)
or defaults to defaultMaxListeners.
Returns#
number
Since
v1.0.0
Inherited from#
EventEmitter.getMaxListeners
Defined in#
node_modules/@types/node/events.d.ts:722
listenerCount#
▸ listenerCount(eventName
, listener?
): number
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.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The name of the event being listened for |
|
|
The event handler function |
Returns#
number
Since
v3.2.0
Inherited from#
EventEmitter.listenerCount
Defined in#
node_modules/@types/node/events.d.ts:816
listeners#
▸ listeners(eventName
): Function
[]
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] ]
Parameters#
Name |
Type |
---|---|
|
|
Returns#
Function
[]
Since
v0.1.26
Inherited from#
EventEmitter.listeners
Defined in#
node_modules/@types/node/events.d.ts:735
off#
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called on successful login with the logged in WebID.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The login event name. |
|
() => |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:212
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called on successful logout.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The logout event name. |
|
() => |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:218
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called on session expiration.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session expiration event name. |
|
() => |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:224
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called on session restoration after a silent login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session restoration event name. |
|
( |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:230
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called on error, with an error identifier and description.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The error event name. |
|
( |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:236
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called on session extension.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session extension event name. |
|
( |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:242
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called when a timeout is set for a session event.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The timeout set event name. |
|
( |
The callback called when next setting a timeout. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:248
▸ off(eventName
, listener
): ISessionEventListener
Unegister a listener called when a new refresh token is issued.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The new refresh token issued event name. |
|
( |
The callback called next time a new refresh token is issued. |
Returns#
Overrides#
EventEmitter.off
Defined in#
packages/core/dist/SessionEventListener.d.ts:254
on#
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called on successful login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The login event name |
|
() => |
The callback called on successful login |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:49
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called on successful logout.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The logout event name. |
|
() => |
The callback called on successful logout. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:55
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called on session expiration.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session expiration event name. |
|
() => |
The callback called on session expiration. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:61
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called on session restoration after a silent login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session restoration event name. |
|
( |
The callback called on successful session restore. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:67
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called on error, with an error identifier and description.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The error event name. |
|
( |
The callback called on error. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:73
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called on session extension.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session extension event name. |
|
( |
The callback called on session extension. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:79
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called when a timeout is set for a session event with the timeout handle.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The timeout set event name. |
|
( |
The callback called when setting a timeout. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:86
▸ on(eventName
, listener
): ISessionEventListener
Register a listener called when a new refresh token is issued for the session.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The new refresh token issued event name. |
|
( |
The callback called when a new refresh token is issued. |
Returns#
Overrides#
EventEmitter.on
Defined in#
packages/core/dist/SessionEventListener.d.ts:92
once#
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called on the next successful login with the logged in WebID.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The login event name. |
|
() => |
The callback called on the next successful login. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:157
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called on the next successful logout.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The logout event name. |
|
() => |
The callback called on the next successful logout. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:163
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called on the next session expiration.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session expiration event name. |
|
() => |
The callback called on the next session expiration. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:169
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called on the next session restoration after a silent login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session restoration event name. |
|
( |
The callback called on the next successful session restore. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:175
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called on the next error, with an error identifier and description.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The error event name. |
|
( |
The callback called on the next error. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:181
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called on the next session extension.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session extension event name. |
|
( |
The callback called on the next session extension. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:187
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called the next time a timeout is set for a session event with the timeout handle.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The timeout set event name. |
|
( |
The callback called when next setting a timeout. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:194
▸ once(eventName
, listener
): ISessionEventListener
Register a listener called the next time a new refresh token is issued for the session.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The new refresh token issued event name. |
|
( |
The callback called next time a new refresh token is issued. |
Returns#
Overrides#
EventEmitter.once
Defined in#
packages/core/dist/SessionEventListener.d.ts:201
prependListener#
▸ prependListener(eventName
, listener
): ISessionEventListener
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#
Name |
Type |
Description |
---|---|---|
|
|
The name of the event. |
|
(… |
The callback function |
Returns#
Since
v6.0.0
Inherited from#
EventEmitter.prependListener
Defined in#
node_modules/@types/node/events.d.ts:834
prependOnceListener#
▸ prependOnceListener(eventName
, listener
): ISessionEventListener
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#
Name |
Type |
Description |
---|---|---|
|
|
The name of the event. |
|
(… |
The callback function |
Returns#
Since
v6.0.0
Inherited from#
EventEmitter.prependOnceListener
Defined in#
node_modules/@types/node/events.d.ts:850
rawListeners#
▸ rawListeners(eventName
): Function
[]
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');
Parameters#
Name |
Type |
---|---|
|
|
Returns#
Function
[]
Since
v9.4.0
Inherited from#
EventEmitter.rawListeners
Defined in#
node_modules/@types/node/events.d.ts:766
removeAllListeners#
▸ removeAllListeners(event?
): ISessionEventListener
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#
Name |
Type |
---|---|
|
|
Returns#
Since
v0.1.26
Inherited from#
EventEmitter.removeAllListeners
Defined in#
node_modules/@types/node/events.d.ts:706
removeListener#
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called on successful login with the logged in WebID.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The login event name. |
|
() => |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:265
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called on successful logout.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The logout event name. |
|
() => |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:271
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called on session expiration.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session expiration event name. |
|
() => |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:277
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called on session restoration after a silent login.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session restoration event name. |
|
( |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:283
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called on error, with an error identifier and description.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The error event name. |
|
( |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:289
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called on session extension.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The session extension event name. |
|
( |
The callback to unregister. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:295
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called when a timeout is set for a session event.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The timeout set event name. |
|
( |
The callback called when next setting a timeout. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:301
▸ removeListener(eventName
, listener
): ISessionEventListener
Unegister a listener called when a new refresh token is issued.
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The new refresh token issued event name. |
|
( |
The callback called next time a new refresh token is issued. |
Returns#
Overrides#
EventEmitter.removeListener
Defined in#
packages/core/dist/SessionEventListener.d.ts:307
setMaxListeners#
▸ setMaxListeners(n
): ISessionEventListener
By default EventEmitter
s 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 toInfinity
(or 0
) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter
, so that calls can be chained.
Parameters#
Name |
Type |
---|---|
|
|
Returns#
Since
v0.3.5
Inherited from#
EventEmitter.setMaxListeners
Defined in#
node_modules/@types/node/events.d.ts:716