@jupyterlite


@jupyterlite / @jupyterlite/contents / IDriveContentsProcessor

Interface: IDriveContentsProcessor#

Defined in: packages/services/lib/contents/drivecontents.d.ts:3

Methods#

get()#

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

Defined in: packages/services/lib/contents/drivecontents.d.ts:57

Process the request to get the content of a file

Parameters#

request#

TDriveRequest<"get">

the request

Returns#

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


getattr()#

getattr(request): Promise<IStats>

Defined in: packages/services/lib/contents/drivecontents.d.ts:51

Process the request to get a node stats

Parameters#

request#

TDriveRequest<"getattr">

the request

Returns#

Promise<IStats>


getmode()#

getmode(request): Promise<number>

Defined in: packages/services/lib/contents/drivecontents.d.ts:33

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

Parameters#

request#

TDriveRequest<"getmode">

the request

Returns#

Promise<number>


lookup()#

lookup(request): Promise<ILookup>

Defined in: packages/services/lib/contents/drivecontents.d.ts:39

Process the request to check if a node exist

Parameters#

request#

TDriveRequest<"lookup">

the request

Returns#

Promise<ILookup>


mknod()#

mknod(request): Promise<null>

Defined in: packages/services/lib/contents/drivecontents.d.ts:45

Process the request to create a directory/file

Parameters#

request#

TDriveRequest<"mknod">

the request

Returns#

Promise<null>


processDriveRequest()#

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

Defined in: packages/services/lib/contents/drivecontents.d.ts:9

Process a content request

Type Parameters#

T#

T extends TDriveMethod

Parameters#

request#

TDriveRequest<T>

the request

Returns#

Promise<TDriveResponse<T>>


put()#

put(request): Promise<null>

Defined in: packages/services/lib/contents/drivecontents.d.ts:63

Process the request to write the content of a file

Parameters#

request#

TDriveRequest<"put">

the request

Returns#

Promise<null>


readdir()#

readdir(request): Promise<string[]>

Defined in: packages/services/lib/contents/drivecontents.d.ts:15

Process the request to read a directory content

Parameters#

request#

TDriveRequest<"readdir">

the request

Returns#

Promise<string[]>


rename()#

rename(request): Promise<null>

Defined in: packages/services/lib/contents/drivecontents.d.ts:27

Process the request to rename a file or directory

Parameters#

request#

TDriveRequest<"rename">

the request

Returns#

Promise<null>


rmdir()#

rmdir(request): Promise<null>

Defined in: packages/services/lib/contents/drivecontents.d.ts:21

Process the request to remove a directory

Parameters#

request#

TDriveRequest<"rmdir">

the request

Returns#

Promise<null>