Class SessionAPIClient

constructor

• new SessionAPIClient(
      options: { serverSettings?: ServerConnection.ISettings },
  ): SessionAPIClient

• Create a new session API client.

  Parameters

  • options: { serverSettings?: ServerConnection.ISettings }

    The options used to create the client.

  Returns SessionAPIClient

ReadonlyserverSettings

getModel

• getModel(id: string): Promise<Session.IModel>

• Get a session model.

  Parameters

  • id: string

    The id of the session of interest.

  Returns Promise<Session.IModel>

  A promise that resolves with the session model.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

listRunning

• listRunning(): Promise<Session.IModel[]>

• List the running sessions.

  Returns Promise<Session.IModel[]>

  A promise that resolves with the list of running session models.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

shutdown

• shutdown(id: string): Promise<void>

• Shut down a session by id.

  Parameters

  • id: string

    The id of the session to shut down.

  Returns Promise<void>

  A promise that resolves when the session is shut down.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

startNew

• startNew(options: ISessionOptions): Promise<Session.IModel>

• Create a new session.

  Parameters

  • options: ISessionOptions

    The options used to create the session.

  Returns Promise<Session.IModel>

  A promise that resolves with the session model.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.

update

• update(
      model: Pick<Session.IModel, "id"> & DeepPartial<
          Omit<Session.IModel, "id">,
      >,
  ): Promise<Session.IModel>

• Update a session by id.

  Parameters

  • model: Pick<Session.IModel, "id"> & DeepPartial<Omit<Session.IModel, "id">>

    The session model to update.

  Returns Promise<Session.IModel>

  A promise that resolves with the updated session model.

  Notes

  Uses the Jupyter Server API and validates the response model.

  The promise is fulfilled on a valid response and rejected otherwise.