@jupyterlite

***`

@jupyterlite / @jupyterlite/contents / ServiceWorkerContentsAPI

Class: ServiceWorkerContentsAPI#

Defined in: packages/services/lib/contents/drivefs.d.ts:137

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

Extends#

Constructors#

Constructor#

**new ServiceWorkerContentsAPI**(options): ServiceWorkerContentsAPI

Defined in: packages/services/lib/contents/drivefs.d.ts:141

Construct a new ServiceWorkerContentsAPI.

Parameters#

options#

IOptions

Returns#

ServiceWorkerContentsAPI

Overrides#

ContentsAPI.constructor

Properties#

ERRNO_CODES#

protected **ERRNO\_CODES**: any

Defined in: packages/services/lib/contents/drivefs.d.ts:132

Inherited from#

ContentsAPI.ERRNO_CODES

`***

FS#

protected FS: FS

Defined in: packages/services/lib/contents/drivefs.d.ts:131

Inherited from#

ContentsAPI.FS

Accessors#

endpoint#

Get Signature#

get endpoint(): string

Defined in: packages/services/lib/contents/drivefs.d.ts:146

Get the api/drive endpoint

Returns#

string

Methods#

get()#

get(path): IFile

Defined in: packages/services/lib/contents/drivefs.d.ts:119

Parameters#

path#

string

Returns#

IFile

Inherited from#

ContentsAPI.get

***`

getattr()#

**getattr**(path): IStats

Defined in: packages/services/lib/contents/drivefs.d.ts:121

Parameters#

path#

string

Returns#

IStats

Inherited from#

ContentsAPI.getattr

`***

getmode()#

getmode(path): number

Defined in: packages/services/lib/contents/drivefs.d.ts:114

Parameters#

path#

string

Returns#

number

Inherited from#

ContentsAPI.getmode

***`

lookup()#

**lookup**(path): ILookup

Defined in: packages/services/lib/contents/drivefs.d.ts:113

Parameters#

path#

string

Returns#

ILookup

Inherited from#

ContentsAPI.lookup

`***

mknod()#

mknod(path, mode): null

Defined in: packages/services/lib/contents/drivefs.d.ts:115

Parameters#

path#

string

mode#

number

Returns#

null

Inherited from#

ContentsAPI.mknod

***`

normalizePath()#

**normalizePath**(path): string

Defined in: packages/services/lib/contents/drivefs.d.ts:127

Normalize a Path by making it compliant for the content manager

Parameters#

path#

string

Returns#

string

Inherited from#

ContentsAPI.normalizePath

`***

put()#

put(path, value): null

Defined in: packages/services/lib/contents/drivefs.d.ts:120

Parameters#

path#

string

value#

IFile

Returns#

null

Inherited from#

ContentsAPI.put

***`

readdir()#

**readdir**(path): string[]

Defined in: packages/services/lib/contents/drivefs.d.ts:117

Parameters#

path#

string

Returns#

string[]

Inherited from#

ContentsAPI.readdir

`***

rename()#

rename(oldPath, newPath): null

Defined in: packages/services/lib/contents/drivefs.d.ts:116

Parameters#

oldPath#

string

newPath#

string

Returns#

null

Inherited from#

ContentsAPI.rename

***`

request()#

**request**\<T\>(data): [TDriveResponse](../type-aliases/TDriveResponse.md)\<T`>

Defined in: packages/services/lib/contents/drivefs.d.ts:142

Type Parameters#

T#

T extends TDriveMethod

Parameters#

data#

TDriveRequest<T>

Returns#

TDriveResponse<T>

Overrides#

ContentsAPI.request

***`

rmdir()#

**rmdir**(path): null`

Defined in: packages/services/lib/contents/drivefs.d.ts:118

Parameters#

path#

string

Returns#

null

Inherited from#

ContentsAPI.rmdir