@jupyterlite

@jupyterlite / @jupyterlite/services / ContentsAPI

Class: abstract ContentsAPI#

Defined in: packages/services/src/contents/drivefs.ts:451

ContentsAPI base class

Extended by#

Constructors#

Constructor#

new ContentsAPI(options): ContentsAPI

Defined in: packages/services/src/contents/drivefs.ts:452

Parameters#

options#

IOptions

Returns#

ContentsAPI

Properties#

ERRNO_CODES#

protected ERRNO_CODES: any

Defined in: packages/services/src/contents/drivefs.ts:608

FS#

protected FS: FS

Defined in: packages/services/src/contents/drivefs.ts:607

Methods#

get()#

get(path): IFile

Defined in: packages/services/src/contents/drivefs.ts:498

Parameters#

path#

string

Returns#

IFile

getattr()#

getattr(path): IStats

Defined in: packages/services/src/contents/drivefs.ts:564

Parameters#

path#

string

Returns#

IStats

getmode()#

getmode(path): number

Defined in: packages/services/src/contents/drivefs.ts:464

Parameters#

path#

string

Returns#

number

lookup()#

lookup(path): ILookup

Defined in: packages/services/src/contents/drivefs.ts:460

Parameters#

path#

string

Returns#

ILookup

mknod()#

mknod(path, mode): null

Defined in: packages/services/src/contents/drivefs.ts:468

Parameters#

path#

string

mode#

number

Returns#

null

normalizePath()#

normalizePath(path): string

Defined in: packages/services/src/contents/drivefs.ts:588

Normalize a Path by making it compliant for the content manager

Parameters#

path#

string

Returns#

string

put()#

put(path, value): null

Defined in: packages/services/src/contents/drivefs.ts:535

Parameters#

path#

string

value#

IFile

Returns#

null

readdir()#

readdir(path): string[]

Defined in: packages/services/src/contents/drivefs.ts:484

Parameters#

path#

string

Returns#

string[]

rename()#

rename(oldPath, newPath): null

Defined in: packages/services/src/contents/drivefs.ts:476

Parameters#

oldPath#

string

newPath#

string

Returns#

null

request()#

abstract request<T>(data): TDriveResponse<T>

Defined in: packages/services/src/contents/drivefs.ts:602

Type Parameters#

T#

T extends TDriveMethod

Parameters#

data#

TDriveRequest<T>

Returns#

TDriveResponse<T>

rmdir()#

rmdir(path): null

Defined in: packages/services/src/contents/drivefs.ts:494

Parameters#

path#

string

Returns#

null