Class: ContentsAPI

@jupyterlite/contents.ContentsAPI

Wrap ServiceWorker requests for an Emscripten-compatible synchronous API.

Constructors

constructor

new ContentsAPI(baseUrl, driveName, mountpoint, FS, ERRNO_CODES)

Parameters

Name	Type
baseUrl	string
driveName	string
mountpoint	string
FS	FS
ERRNO_CODES	any

Defined in

packages/contents/src/drivefs.ts:292

Properties

ERRNO_CODES

Private ERRNO_CODES: any

Defined in

packages/contents/src/drivefs.ts:466

FS

Private FS: FS

Defined in

packages/contents/src/drivefs.ts:465

_baseUrl

Private _baseUrl: string

Defined in

packages/contents/src/drivefs.ts:462

_driveName

Private _driveName: string

Defined in

packages/contents/src/drivefs.ts:463

_mountpoint

Private _mountpoint: string

Defined in

packages/contents/src/drivefs.ts:464

Accessors

endpoint

get endpoint(): string

Get the api/drive endpoint

Returns

string

Defined in

packages/contents/src/drivefs.ts:458

Methods

get

get(path): IFile

Parameters

Name	Type
path	string

Returns

IFile

Defined in

packages/contents/src/drivefs.ts:363

getattr

getattr(path): IStats

Parameters

Name	Type
path	string

Returns

IStats

Defined in

packages/contents/src/drivefs.ts:422

getmode

getmode(path): number

Parameters

Name	Type
path	string

Returns

number

Defined in

packages/contents/src/drivefs.ts:327

lookup

lookup(path): ILookup

Parameters

Name	Type
path	string

Returns

ILookup

Defined in

packages/contents/src/drivefs.ts:323

mknod

mknod(path, mode): any

Parameters

Name	Type
path	string
mode	number

Returns

any

Defined in

packages/contents/src/drivefs.ts:333

normalizePath

normalizePath(path): string

Normalize a Path by making it compliant for the content manager

Parameters

Name	Type
path	string

Returns

string

Defined in

packages/contents/src/drivefs.ts:441

put

put(path, value): any

Parameters

Name	Type
path	string
value	IFile

Returns

any

Defined in

packages/contents/src/drivefs.ts:393

readdir

readdir(path): string[]

Parameters

Name	Type
path	string

Returns

string[]

Defined in

packages/contents/src/drivefs.ts:349

rename

rename(oldPath, newPath): void

Parameters

Name	Type
oldPath	string
newPath	string

Returns

void

Defined in

packages/contents/src/drivefs.ts:341

request

request(data): any

Parameters

Name	Type
data	IDriveRequest

Returns

any

Defined in

packages/contents/src/drivefs.ts:306

rmdir

rmdir(path): void

Parameters

Name	Type
path	string

Returns

void

Defined in

packages/contents/src/drivefs.ts:359