Class: ServiceWorkerContentsAPI

@jupyterlite/contents.ServiceWorkerContentsAPI

An Emscripten-compatible synchronous Contents API using the service worker.

Hierarchy

• ContentsAPI

  ↳ ServiceWorkerContentsAPI

Constructors

constructor

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

Parameters

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

Overrides

ContentsAPI.constructor

Defined in

packages/contents/src/drivefs.ts:558

Properties

ERRNO_CODES

Protected ERRNO_CODES: any

Inherited from

ContentsAPI.ERRNO_CODES

Defined in

packages/contents/src/drivefs.ts:551

FS

Protected FS: FS

Inherited from

ContentsAPI.FS

Defined in

packages/contents/src/drivefs.ts:550

_baseUrl

Private _baseUrl: string

Defined in

packages/contents/src/drivefs.ts:594

Accessors

endpoint

get endpoint(): string

Get the api/drive endpoint

Returns

string

Defined in

packages/contents/src/drivefs.ts:590

Methods

get

get(path): IFile

Parameters

Name	Type
path	string

Returns

IFile

Inherited from

ContentsAPI.get

Defined in

packages/contents/src/drivefs.ts:440

getattr

getattr(path): IStats

Parameters

Name	Type
path	string

Returns

IStats

Inherited from

ContentsAPI.getattr

Defined in

packages/contents/src/drivefs.ts:506

getmode

getmode(path): number

Parameters

Name	Type
path	string

Returns

number

Inherited from

ContentsAPI.getmode

Defined in

packages/contents/src/drivefs.ts:406

lookup

lookup(path): ILookup

Parameters

Name	Type
path	string

Returns

ILookup

Inherited from

ContentsAPI.lookup

Defined in

packages/contents/src/drivefs.ts:402

mknod

mknod(path, mode): null

Parameters

Name	Type
path	string
mode	number

Returns

null

Inherited from

ContentsAPI.mknod

Defined in

packages/contents/src/drivefs.ts:410

normalizePath

normalizePath(path): string

Normalize a Path by making it compliant for the content manager

Parameters

Name	Type
path	string

Returns

string

Inherited from

ContentsAPI.normalizePath

Defined in

packages/contents/src/drivefs.ts:531

put

put(path, value): null

Parameters

Name	Type
path	string
value	IFile

Returns

null

Inherited from

ContentsAPI.put

Defined in

packages/contents/src/drivefs.ts:477

readdir

readdir(path): string[]

Parameters

Name	Type
path	string

Returns

string[]

Inherited from

ContentsAPI.readdir

Defined in

packages/contents/src/drivefs.ts:426

rename

rename(oldPath, newPath): null

Parameters

Name	Type
oldPath	string
newPath	string

Returns

null

Inherited from

ContentsAPI.rename

Defined in

packages/contents/src/drivefs.ts:418

request

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

Type parameters

Name	Type
T	extends TDriveMethod

Parameters

Name	Type
data	TDriveRequest<T>

Returns

TDriveResponse<T>

Overrides

ContentsAPI.request

Defined in

packages/contents/src/drivefs.ts:570

rmdir

rmdir(path): null

Parameters

Name	Type
path	string

Returns

null

Inherited from

ContentsAPI.rmdir

Defined in

packages/contents/src/drivefs.ts:436