[**@jupyterlite**](../../../README.md)

***

[@jupyterlite](../../../README.md) / [@jupyterlite/services](../README.md) / ServiceWorkerContentsAPI

# Class: ServiceWorkerContentsAPI

Defined in: [packages/services/src/contents/drivefs.ts:614](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L614)

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

## Extends

- [`ContentsAPI`](ContentsAPI.md)

## Constructors

### Constructor

> **new ServiceWorkerContentsAPI**(`options`): `ServiceWorkerContentsAPI`

Defined in: [packages/services/src/contents/drivefs.ts:618](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L618)

Construct a new ServiceWorkerContentsAPI.

#### Parameters

##### options

[`IOptions`](../namespaces/ServiceWorkerContentsAPI/interfaces/IOptions.md)

#### Returns

`ServiceWorkerContentsAPI`

#### Overrides

[`ContentsAPI`](ContentsAPI.md).[`constructor`](ContentsAPI.md#constructor)

## Properties

### ERRNO\_CODES

> `protected` **ERRNO\_CODES**: `any`

Defined in: [packages/services/src/contents/drivefs.ts:608](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L608)

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`ERRNO_CODES`](ContentsAPI.md#errno_codes)

***

### FS

> `protected` **FS**: [`FS`](../type-aliases/FS.md)

Defined in: [packages/services/src/contents/drivefs.ts:607](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L607)

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`FS`](ContentsAPI.md#fs)

## Accessors

### endpoint

#### Get Signature

> **get** **endpoint**(): `string`

Defined in: [packages/services/src/contents/drivefs.ts:655](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L655)

Get the api/drive endpoint

##### Returns

`string`

## Methods

### get()

> **get**(`path`): [`IFile`](../namespaces/DriveFS/interfaces/IFile.md)

Defined in: [packages/services/src/contents/drivefs.ts:498](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L498)

#### Parameters

##### path

`string`

#### Returns

[`IFile`](../namespaces/DriveFS/interfaces/IFile.md)

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`get`](ContentsAPI.md#get)

***

### getattr()

> **getattr**(`path`): [`IStats`](../interfaces/IStats.md)

Defined in: [packages/services/src/contents/drivefs.ts:564](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L564)

#### Parameters

##### path

`string`

#### Returns

[`IStats`](../interfaces/IStats.md)

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`getattr`](ContentsAPI.md#getattr)

***

### getmode()

> **getmode**(`path`): `number`

Defined in: [packages/services/src/contents/drivefs.ts:464](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L464)

#### Parameters

##### path

`string`

#### Returns

`number`

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`getmode`](ContentsAPI.md#getmode)

***

### lookup()

> **lookup**(`path`): [`ILookup`](../namespaces/DriveFS/interfaces/ILookup.md)

Defined in: [packages/services/src/contents/drivefs.ts:460](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L460)

#### Parameters

##### path

`string`

#### Returns

[`ILookup`](../namespaces/DriveFS/interfaces/ILookup.md)

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`lookup`](ContentsAPI.md#lookup)

***

### mknod()

> **mknod**(`path`, `mode`): `null`

Defined in: [packages/services/src/contents/drivefs.ts:468](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L468)

#### Parameters

##### path

`string`

##### mode

`number`

#### Returns

`null`

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`mknod`](ContentsAPI.md#mknod)

***

### normalizePath()

> **normalizePath**(`path`): `string`

Defined in: [packages/services/src/contents/drivefs.ts:588](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L588)

Normalize a Path by making it compliant for the content manager

#### Parameters

##### path

`string`

#### Returns

`string`

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`normalizePath`](ContentsAPI.md#normalizepath)

***

### put()

> **put**(`path`, `value`): `null`

Defined in: [packages/services/src/contents/drivefs.ts:535](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L535)

#### Parameters

##### path

`string`

##### value

[`IFile`](../namespaces/DriveFS/interfaces/IFile.md)

#### Returns

`null`

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`put`](ContentsAPI.md#put)

***

### readdir()

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

Defined in: [packages/services/src/contents/drivefs.ts:484](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L484)

#### Parameters

##### path

`string`

#### Returns

`string`[]

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`readdir`](ContentsAPI.md#readdir)

***

### rename()

> **rename**(`oldPath`, `newPath`): `null`

Defined in: [packages/services/src/contents/drivefs.ts:476](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L476)

#### Parameters

##### oldPath

`string`

##### newPath

`string`

#### Returns

`null`

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`rename`](ContentsAPI.md#rename)

***

### request()

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

Defined in: [packages/services/src/contents/drivefs.ts:625](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L625)

#### Type Parameters

##### T

`T` *extends* [`TDriveMethod`](../type-aliases/TDriveMethod.md)

#### Parameters

##### data

[`TDriveRequest`](../type-aliases/TDriveRequest.md)\<`T`\>

#### Returns

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

#### Overrides

[`ContentsAPI`](ContentsAPI.md).[`request`](ContentsAPI.md#request)

***

### rmdir()

> **rmdir**(`path`): `null`

Defined in: [packages/services/src/contents/drivefs.ts:494](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drivefs.ts#L494)

#### Parameters

##### path

`string`

#### Returns

`null`

#### Inherited from

[`ContentsAPI`](ContentsAPI.md).[`rmdir`](ContentsAPI.md#rmdir)