@openhps/solid
    Preparing search index...

    Class SolidClientService

    Solid client service

    Hierarchy (View Summary)

    Index
    _clientAuthentication: ClientAuthentication
    _session: SolidSession
    clientRegistrar: ClientRegistrar
    dependencies?: (new (...args: any[]) => Service)[]

    Dependencies that need to be resolved before the service is ready

    driver: DataServiceDriver<string, string>
    express: Express
    localServices: Set<string>
    model: Model<any, any>
    nodes: Set<string>
    promises: Map<
        string,
        { reject: (ex?: any) => void; resolve: (data?: any) => void },
    >
    remoteServices: Set<string>
    sessionManager: SessionManager
    storage: IStorage
    storageUtility: StorageUtility
    uid: string

    Service name

    PREFIX: "OpenHPS:solid" = 'OpenHPS:solid'
    • get clientAuthentication(): ClientAuthentication

      Returns ClientAuthentication

    • The 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.
      }
      }

      Parameters

      • error: Error
      • event: string | symbol
      • ...args: any[]

      Returns void

      v13.4.0, v12.16.0

    • Add a dependency to the service

      Parameters

      • dependency: new (...args: any[]) => Service

        Service dependency

      Returns this

      Service instance

    • Alias for emitter.on(eventName, listener).

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v0.1.26

    • Create a Solid container

      Parameters

      • session: SolidSession

        Solid session to create a container with

      • url: `http://${string}` | `https://${string}`

        URL of the container

      Returns Promise<
          Readonly<
              {
                  graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                  type: "Dataset";
              },
          >,
      >

      Promise of the container

    • Set a thing in a session Pod

      Parameters

      • session: SolidSession

        Solid session to set a thing to

      • thing: Thing

        Non-persisted thing to store in the Pod

      • Optionaldataset: SolidDataset

      Returns Promise<
          Readonly<
              {
                  graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                  type: "Dataset";
              },
          >,
      >

      Promise if stored

    • Recursively delete a Solid dataset

      Parameters

      • session: SolidSession

        Solid session to delete a dataset with

      • dataset: Readonly<
            {
                graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                type: "Dataset";
            },
        > & WithResourceInfo

        Dataset to delete

      Returns Promise<void>

    • Recursively delete a Solid dataset

      Parameters

      • session: SolidSession

        Solid session to delete a dataset with

      • url: `http://${string}` | `https://${string}`

        URL of the dataset

      Returns Promise<void>

    • 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

      Parameters

      • name: string | symbol
      • ...args: any[]

      Returns boolean

      v0.1.26

    • Service ready

      Parameters

      • name: "ready"

        ready

      Returns boolean

    • Destroy the service

      Parameters

      • name: "destroy"

        destroy

      Returns boolean

    • 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) ]

      Returns (string | symbol)[]

      v6.0.0

    • Returns string

    • Get access control list for a specific resource

      Parameters

      • uri: `http://${string}` | `https://${string}`
      • webId: string = foaf.Agent

        WebID to get access control list for

      • Optionalsession: SolidSession

        Session to use

      Returns Promise<AccessModes>

      Access control list

    • Get a Solid dataset

      Parameters

      • session: SolidSession

        Solid session to get a thing from

      • uri: string

        URI of the thing in the Solid Pod

      Returns Promise<
          Readonly<
              {
                  graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                  type: "Dataset";
              },
          >,
      >

      Promise of a solid dataset

    • Get a Solid dataset as an N3 Quads dataset

      Parameters

      • session: SolidSession

        Solid session to get a thing from

      • uri: string

        URI of the thing in the Solid Pod

      Returns Promise<
          Store<Quad, Quad, Quad, Quad> & RDFChangeLog & Readonly<
              {
                  graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                  type: "Dataset";
              },
          >,
      >

      Promise of a solid dataset store

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

      Returns number

      v1.0.0

    • Parameters

      • uuid: string

      Returns { reject: (ex?: any) => void; resolve: (data?: any) => void }

    • Returns boolean

    • Parameters

      • object: DataObject | DataFrame
      • sessionId: string
      • Optionaltype: Serializable<any>

      Returns Promise<void>

    • 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

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

      • Optionallistener: (...args: any[]) => void

        The event handler function

      Returns number

      v3.2.0

    • 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

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

      Returns ((...args: any[]) => void)[]

      v0.1.26

    • Local positioning model event

      Parameters

      • uid: string

        UID of the node

      • event: string

        Event name

      • Optional...args: any[]

        Argument

      Returns void

    • Local positioning model pull

      Parameters

      • uid: string

        UID of the node

      • Optionaloptions: RemotePullOptions

        Pull options

      Returns void

    • Local positioning model push

      Parameters

      • uid: string

        UID of the node

      • frame: any

        Data frame

      • Optionaloptions: RemotePushOptions

        Push options

      Returns void

    • Local service call

      Parameters

      • uid: string

        Service uid

      • method: string

        Method name

      • Optional...args: any[]

        optional arguments

      Returns any

      service call output

    • Parameters

      • level: "debug"
      • message: string
      • Optionaldata: any

      Returns void

    • Parameters

      • level: "info"
      • message: string
      • Optionaldata: any

      Returns void

    • Parameters

      • level: "warn"
      • message: string
      • Optionaldata: any

      Returns void

    • Parameters

      • level: "error"
      • message: string
      • Optionalerror: Error

      Returns void

    • Parameters

      • level: string

        Logging level

      • log: any

        Logging data or message

      Returns void

    • Login a Solid user

      Parameters

      • oidcIssuer: string = ...

        OpenID Issuer

      • interactive: boolean = false

      Returns Promise<Session>

      Session promise

    • Alias for emitter.removeListener().

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v10.0.0

    • 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

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v0.1.101

    • 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

      • name: string | symbol
      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v0.3.0

    • Event called when service is destroyed

      Parameters

      • name: "destroy"

        destroy

      • listener: () => void | Promise<void>

        Event callback

      Returns this

    • Event called when service is build

      Parameters

      • name: "build"

        build

      • listener: () => void | Promise<void>

        Event callback

      Returns this

    • Event called when service is ready

      Parameters

      • name: "ready"

        ready

      • listener: () => void | Promise<void>

        Event callback

      Returns this

    • 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.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v6.0.0

    • 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.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v6.0.0

    • 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

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

      Returns ((...args: any[]) => void)[]

      v9.4.0

    • Register a node as a remotely available node

      Parameters

      • node: string | Node<any, any>

        Node to register

      Returns Promise<void>

      Promise of registration

    • Parameters

      • resolve: (data?: any) => void
      • reject: (ex?: any) => void
      • Optionalid: string

      Returns string

    • Register a service to be remotely available

      Parameters

      • service: Service

        Service to register

      Returns Promise<void>

      Promise of registration

    • Send an error to a remote node

      Parameters

      • uid: string

        Remote Node UID

      • event: string

        Event to send

      • Optional...args: any[]

        Event argument

      Returns Promise<void>

    • Send a pull request to a specific remote node

      Parameters

      • uid: string

        Remote Node UID

      • Optionaloptions: PullOptions

        Pull options

      Returns Promise<void>

    • Send a push to a specific remote node

      Type Parameters

      • T extends DataFrame | DataFrame[]

      Parameters

      • uid: string

        Remote Node UID

      • frame: T

        Data frame to push

      • Optionaloptions: PushOptions

        Push options

      Returns Promise<void>

    • Send a remote service call

      Parameters

      • uid: string

        Service uid

      • method: string

        Method to call

      • Optional...args: any[]

        Optional set of arguments

      Returns Promise<any>

    • 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.

      Type Parameters

      • E extends string | symbol

      Parameters

      • OptionaleventName: string | symbol

      Returns this

      v0.1.26

    • 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 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.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v0.1.26

    • Save a Solid dataset

      Parameters

      • session: SolidSession

        Solid session to get a thing from

      • uri: string

        URI of the thing in the Solid Pod

      • Optionaldataset:
            | Store<Quad, Quad, Quad, Quad>
            | Readonly<
                {
                    graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                    type: "Dataset";
                },
            >
            | Store<Quad, Quad, Quad, Quad> & RDFChangeLog & Readonly<
                {
                    graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                    type: "Dataset";
                },
            >
            | Store<Quad, Quad, Quad, Quad> & RDFChangeLog

        Dataset to save at the uri

      • Optionalappend: boolean

        Append in container

      Returns Promise<
          Readonly<
              {
                  graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                  type: "Dataset";
              },
          > & WithResourceInfo,
      >

      Promise of a solid dataset

    • Set access control list for a specific object

      Parameters

      • uri: `http://${string}` | `https://${string}`

        URI of the object

      • access: Partial<AccessModes & { default?: boolean; group?: boolean; public?: boolean }>

        Access modes

      • OptionalwebId: string = foaf.Agent

        WebID to set access for

      • Optionalsession: SolidSession

        Session to use

      Returns Promise<void>

    • 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

      v0.3.5

    • Set a thing in a session Pod

      Parameters

      • session: SolidSession

        Solid session to set a thing to

      • thing: ThingPersisted

        Persisted thing to store in the Pod

      Returns Promise<
          Readonly<
              {
                  graphs: Readonly<Record<IriString, Graph> & { default: Graph }>;
                  type: "Dataset";
              },
          >,
      >

      Promise if stored

    • Parameters

      • uid: string

      Returns this

    • Parameters

      • object: string | DataObject | DataFrame
      • Optionaltype: Serializable<any>

      Returns Promise<void>