Class: DriveContentsProcessor#

@jupyterlite/contents.DriveContentsProcessor

Class for processing a drive request from the DriveFS.

Implements#

Constructors#

constructor#

new DriveContentsProcessor(options)

Parameters#

Name

Type

options

IOptions

Defined in#

packages/contents/src/drivecontents.ts:86

Properties#

contentsManager#

Private contentsManager: IManager

Defined in#

packages/contents/src/drivecontents.ts:84

Methods#

get#

get(request): Promise<undefined | { content: any ; format: FileFormat }>

Process the request to get the content of a file

Parameters#

Name

Type

Description

request

TDriveRequest<"get">

the request

Returns#

Promise<undefined | { content: any ; format: FileFormat }>

Implementation of#

IDriveContentsProcessor.get

Defined in#

packages/contents/src/drivecontents.ts:209

getattr#

getattr(request): Promise<IStats>

Process the request to get a node stats

Parameters#

Name

Type

Description

request

TDriveRequest<"getattr">

the request

Returns#

Promise<IStats>

Implementation of#

IDriveContentsProcessor.getattr

Defined in#

packages/contents/src/drivecontents.ts:187

getmode#

getmode(request): Promise<number>

Process the request to get the node mode (file or directory)

Parameters#

Name

Type

Description

request

TDriveRequest<"getmode">

the request

Returns#

Promise<number>

Implementation of#

IDriveContentsProcessor.getmode

Defined in#

packages/contents/src/drivecontents.ts:150

lookup#

lookup(request): Promise<ILookup>

Process the request to check if a node exist

Parameters#

Name

Type

Description

request

TDriveRequest<"lookup">

the request

Returns#

Promise<ILookup>

Implementation of#

IDriveContentsProcessor.lookup

Defined in#

packages/contents/src/drivecontents.ts:161

mknod#

mknod(request): Promise<null>

Process the request to create a directory/file

Parameters#

Name

Type

Description

request

TDriveRequest<"mknod">

the request

Returns#

Promise<null>

Implementation of#

IDriveContentsProcessor.mknod

Defined in#

packages/contents/src/drivecontents.ts:177

processDriveRequest#

processDriveRequest<T>(request): Promise<TDriveResponse<T>>

Process a content request

Type parameters#

Name

Type

T

extends TDriveMethod

Parameters#

Name

Type

Description

request

TDriveRequest<T>

the request

Returns#

Promise<TDriveResponse<T>>

Implementation of#

IDriveContentsProcessor.processDriveRequest

Defined in#

packages/contents/src/drivecontents.ts:90

put#

put(request): Promise<null>

Process the request to write the content of a file

Parameters#

Name

Type

Description

request

TDriveRequest<"put">

the request

Returns#

Promise<null>

Implementation of#

IDriveContentsProcessor.put

Defined in#

packages/contents/src/drivecontents.ts:225

readdir#

readdir(request): Promise<string[]>

Process the request to read a directory content

Parameters#

Name

Type

Description

request

TDriveRequest<"readdir">

the request

Returns#

Promise<string[]>

Implementation of#

IDriveContentsProcessor.readdir

Defined in#

packages/contents/src/drivecontents.ts:131

rename#

rename(request): Promise<null>

Process the request to rename a file or directory

Parameters#

Name

Type

Description

request

TDriveRequest<"rename">

the request

Returns#

Promise<null>

Implementation of#

IDriveContentsProcessor.rename

Defined in#

packages/contents/src/drivecontents.ts:145

rmdir#

rmdir(request): Promise<null>

Process the request to remove a directory

Parameters#

Name

Type

Description

request

TDriveRequest<"rmdir">

the request

Returns#

Promise<null>

Implementation of#

IDriveContentsProcessor.rmdir

Defined in#

packages/contents/src/drivecontents.ts:140