Optionaloptions: SolidDataClientOptionsProtected_Protected_ReadonlyclientOptionaldependenciesDependencies that need to be resolved before the service is ready
ProtecteddriverProtectedexpressProtectedlocalProtectednodesProtectedoptionsProtectedpromisesProtectedremoteReadonlysessionProtectedstorageService name
Static ReadonlyPREFIXOptional[captureThe Symbol.for('nodejs.rejection') method is called in case a
promise rejection happens when emitting an event and
captureRejections is enabled on the emitter.
It is possible to use events.captureRejectionSymbol in
place of Symbol.for('nodejs.rejection').
import { EventEmitter, captureRejectionSymbol } from 'node:events';
class MyClass extends EventEmitter {
constructor() {
super({ captureRejections: true });
}
[captureRejectionSymbol](err, event, ...args) {
console.log('rejection happened for', event, 'with', err, ...args);
this.destroy(err);
}
destroy(err) {
// Tear the resource down here.
}
}
Add a dependency to the service
Service dependency
Service instance
Create a Solid container
Solid session to create a container with
URL of the container
Promise of the container
ProtectedcreateSet a thing in a session Pod
Solid session to set a thing to
Non-persisted thing to store in the Pod
Optionaldataset: SolidDatasetPromise if stored
Delete a Solid dataset
Solid session to get a thing from
URI of the thing in the Solid Pod
Promise of a solid dataset
Recursively delete a Solid dataset
Solid session to delete a dataset with
Dataset to delete
Recursively delete a Solid dataset
Solid session to delete a dataset with
URL of the dataset
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
Service ready
ready
Destroy the service
destroy
Returns an array listing the events for which the emitter has registered listeners.
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) ]
Fetch profile information
Data object to fetch profile information for
Promise of data object with profile information
Find session by session identifier
Session identifier
Browser or Node session
Find session by object identifier
Data type of data object or data frame
Object unique identifier
Browser or Node session
Find session by WebID
Web Identifier
Browser or Node session
Find session information by session identifier
Session identifier
Session info
ProtectedgenerateGet access control list for a specific resource
WebID to get access control list for
Optionalsession: SolidSession
Session to use
Access control list
Get a Solid dataset
Solid session to get a thing from
URI of the thing in the Solid Pod
Promise of a solid dataset
Get a Solid dataset as an N3 Quads dataset
Solid session to get a thing from
URI of the thing in the Solid Pod
Promise of a solid dataset store
Get a Solid dataset subscription
Solid session to get a subscription from
URI of the thing in the Solid Pod
Promise of a solid dataset subscription
Get the URL of a document
Solid session to get an URL from
Optionalpath: string
Path to append to the document URL
Document URL
ProtectedgetGet a thing from a session Pod
Solid session to get a thing from
URI of the thing in the Solid Pod
Persisted thing
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.
The name of the event being listened for
Optionallistener: (...args: any[]) => void
The event handler 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] ]
Local positioning model event
UID of the node
Event name
Optional...args: any[]
Argument
Local positioning model pull
UID of the node
Optionaloptions: RemotePullOptions
Pull options
Local positioning model push
UID of the node
Data frame
Optionaloptions: RemotePushOptions
Push options
Local service call
Service uid
Method name
Optional...args: any[]
optional arguments
service call output
Optionaldata: anyOptionaldata: anyOptionaldata: anyOptionalerror: ErrorLogin a Solid user
OpenID Issuer
Session promise
Logout a Solid user
Solid session to logout from
Promise of logging out
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
The name of the event.
The callback function
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
The callback function
Event called when service is destroyed
destroy
Event callback
Event called when service is build
build
Event callback
Event called when service is ready
ready
Event callback
ProtectedonProtectedonAdds 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.
The name of the event.
The callback function
Adds a one-time listener 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.
The name of the event.
The callback 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');
Register a node as a remotely available node
Node to register
Promise of registration
ProtectedregisterOptionalid: stringRegister a service to be remotely available
Service to register
Promise of registration
Send an error to a remote node
Remote Node UID
Event to send
Optional...args: any[]
Event argument
Send a pull request to a specific remote node
Remote Node UID
Optionaloptions: PullOptions
Pull options
Send a push to a specific remote node
Remote Node UID
Data frame to push
Optionaloptions: PushOptions
Push options
Send a remote service call
Service uid
Method to call
Optional...args: any[]
Optional set of arguments
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.
OptionaleventName: string | symbolRemoves 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 from
emit() 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 indexes 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.
Save a Solid dataset
Solid session to get a thing from
URI of the thing in the Solid Pod
Optionaldataset: Dataset to save at the uri
Optionalappend: boolean
Append in container
Promise of a solid dataset
Set access control list for a specific object
URI of the object
Access modes
OptionalwebId: string = foaf.Agent
WebID to set access for
Optionalsession: SolidSession
Session to use
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.
Set a thing in a session Pod
Solid session to set a thing to
Persisted thing to store in the Pod
Promise if stored
Store profile information
Data object to store profile information for
Promise of storing
ProtectedstoreOptionaltype: Serializable<any>
Solid client service