@jupyterlite

***`

@jupyterlite / @jupyterlite/contents / ContentsAPI

Class: ``abstract ContentsAPI#

Defined in: packages/contents/src/drivefs.ts:392

ContentsAPI base class

Extended by#

Constructors#

Constructor#

**new ContentsAPI**(options): ContentsAPI

Defined in: packages/contents/src/drivefs.ts:393

Parameters#

options#

IOptions

Returns#

ContentsAPI

Properties#

ERRNO_CODES#

protected **ERRNO\_CODES**: any

Defined in: packages/contents/src/drivefs.ts:550

`***

FS#

protected FS: FS

Defined in: packages/contents/src/drivefs.ts:549

Methods#

get()#

get(path): IFile

Defined in: packages/contents/src/drivefs.ts:439

Parameters#

path#

string

Returns#

IFile

***`

getattr()#

**getattr**(path): IStats

Defined in: packages/contents/src/drivefs.ts:505

Parameters#

path#

string

Returns#

IStats

`***

getmode()#

getmode(path): number

Defined in: packages/contents/src/drivefs.ts:405

Parameters#

path#

string

Returns#

number

***`

lookup()#

**lookup**(path): ILookup

Defined in: packages/contents/src/drivefs.ts:401

Parameters#

path#

string

Returns#

ILookup

`***

mknod()#

mknod(path, mode): null

Defined in: packages/contents/src/drivefs.ts:409

Parameters#

path#

string

mode#

number

Returns#

null

***`

normalizePath()#

**normalizePath**(path): string

Defined in: packages/contents/src/drivefs.ts:530

Normalize a Path by making it compliant for the content manager

Parameters#

path#

string

Returns#

string

`***

put()#

put(path, value): null

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

Parameters#

path#

string

value#

IFile

Returns#

null

***`

readdir()#

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

Defined in: packages/contents/src/drivefs.ts:425

Parameters#

path#

string

Returns#

string[]

`***

rename()#

rename(oldPath, newPath): null

Defined in: packages/contents/src/drivefs.ts:417

Parameters#

oldPath#

string

newPath#

string

Returns#

null

***`

request()#

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

Defined in: packages/contents/src/drivefs.ts:544

Type Parameters#

T#

T extends TDriveMethod

Parameters#

data#

TDriveRequest<T>

Returns#

TDriveResponse<T>

***`

rmdir()#

**rmdir**(path): null`

Defined in: packages/contents/src/drivefs.ts:435

Parameters#

path#

string

Returns#

null