Class RestContentProvider

A content provider using the Jupyter REST API.

Implements

IContentProvider

Index

Constructors

Methods

Constructors

constructor

new RestContentProvider(
options: RestContentProvider.IOptions,
): RestContentProvider
Parameters
- options: RestContentProvider.IOptions
Returns RestContentProvider
- Defined in packages/services/src/contents/index.ts:1732

Methods

get

get(localPath: string, options?: IFetchOptions): Promise<Contents.IModel>
Get a file or directory.
Parameters
- localPath: string
  The path to the file.
- Optionaloptions: IFetchOptions
  The options used to fetch the file.
Returns Promise<Contents.IModel>
A promise which resolves with the file content.

Uses the Jupyter Server API and validates the response model.
Implementation of IContentProvider.get
- Defined in packages/services/src/contents/index.ts:1747

save

save(
localPath: string,
options?: Partial<Contents.IModel>,
): Promise<Contents.IModel>
Save a file.
Parameters
- localPath: string
  The desired file path.
- options: Partial<Contents.IModel> = {}
  Optional overrides to the model.
Returns Promise<Contents.IModel>
A promise which resolves with the file content model when the file is saved.

Notes
Ensure that model.content is populated for the file.

Uses the Jupyter Server API and validates the response model.
Implementation of IContentProvider.save
- Defined in packages/services/src/contents/index.ts:1789