Interface IOptions

The options used to initialize a Drive.

interface IOptions {
    apiEndpoint?: string;
    defaultContentProvider?: IContentProvider;
    name?: string;
    serverSettings?: ServerConnection.ISettings;
}

Index

Properties

apiEndpoint? defaultContentProvider? name? serverSettings?

Properties

`Optional`apiEndpoint

apiEndpoint?: string

A REST endpoint for drive requests. If not given, defaults to the Jupyter REST API given by Jupyter Server API.

`Optional`defaultContentProvider

defaultContentProvider?: IContentProvider

The default content provider.

`Optional`name

name?: string

The name for the Drive, which is used in file paths to disambiguate it from other drives.

`Optional`serverSettings

serverSettings?: ServerConnection.ISettings

The server settings for the server.