Skip to content

Commit

Permalink
Update deps
Browse files Browse the repository at this point in the history
 - Update docs
  • Loading branch information
HeavenVolkoff committed Aug 2, 2024
1 parent fa98e8b commit 4b5af80
Show file tree
Hide file tree
Showing 35 changed files with 4,109 additions and 3,566 deletions.
8 changes: 6 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
**archive-wasm****Docs**

---

# archive-wasm

## Modules

- [archive-wasm](modules/archive_wasm.md)
- [archive-wasm/src/fs.mjs](modules/archive_wasm_src_fs_mjs.md)
- [archive-wasm](archive-wasm/README.md)
- [archive-wasm/src/fs.mjs](archive-wasm/src/fs.mjs/README.md)
42 changes: 42 additions & 0 deletions docs/archive-wasm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[**archive-wasm**](../README.md)**Docs**

---

# archive-wasm

## File

Idiomatic JavaScript API for extracting most archive files with LibArchive

## Index

### Enumerations

- [EntryTypeName](enumerations/EntryTypeName.md)

### Classes

- [ArchiveError](classes/ArchiveError.md)
- [ExceedSizeLimitError](classes/ExceedSizeLimitError.md)
- [FailedError](classes/FailedError.md)
- [FatalError](classes/FatalError.md)
- [FileReadError](classes/FileReadError.md)
- [NullError](classes/NullError.md)
- [PassphraseError](classes/PassphraseError.md)
- [RetryError](classes/RetryError.md)

### Interfaces

- [Entry](interfaces/Entry.md)
- [ExtractAllExclusiveOpts](interfaces/ExtractAllExclusiveOpts.md)
- [ExtractOpts](interfaces/ExtractOpts.md)

### Type Aliases

- [ExtractAllOpts](type-aliases/ExtractAllOpts.md)

### Functions

- [disableWarning](functions/disableWarning.md)
- [extract](functions/extract.md)
- [extractAll](functions/extractAll.md)
149 changes: 149 additions & 0 deletions docs/archive-wasm/classes/ArchiveError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
[**archive-wasm**](../../README.md)**Docs**

---

# Class: ArchiveError

## Extends

- `Error`

## Extended by

- [`NullError`](NullError.md)
- [`RetryError`](RetryError.md)
- [`FatalError`](FatalError.md)
- [`FailedError`](FailedError.md)
- [`FileReadError`](FileReadError.md)
- [`PassphraseError`](PassphraseError.md)
- [`ExceedSizeLimitError`](ExceedSizeLimitError.md)

## Constructors

### new ArchiveError()

> **new ArchiveError**(`code`, `message`?): [`ArchiveError`](ArchiveError.md)
Main error class

#### Parameters

**code**: `number`

Error code

**message?**: `string`

Error message

#### Returns

[`ArchiveError`](ArchiveError.md)

#### Overrides

`Error.constructor`

## Properties

### cause?

> `optional` **cause**: `unknown`
#### Inherited from

`Error.cause`

---

### code

> **code**: `number`
---

### message

> **message**: `string`
#### Inherited from

`Error.message`

---

### name

> **name**: `string`
#### Inherited from

`Error.name`

---

### stack?

> `optional` **stack**: `string`
#### Inherited from

`Error.stack`

---

### prepareStackTrace()?

> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
Optional override for formatting stack traces

#### Parameters

**err**: `Error`

**stackTraces**: `CallSite`[]

#### Returns

`any`

#### See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

`Error.prepareStackTrace`

---

### stackTraceLimit

> `static` **stackTraceLimit**: `number`
#### Inherited from

`Error.stackTraceLimit`

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
Create .stack property on a target object

#### Parameters

**targetObject**: `object`

**constructorOpt?**: `Function`

#### Returns

`void`

#### Inherited from

`Error.captureStackTrace`
137 changes: 137 additions & 0 deletions docs/archive-wasm/classes/ExceedSizeLimitError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
[**archive-wasm**](../../README.md)**Docs**

---

# Class: ExceedSizeLimitError

## Extends

- [`ArchiveError`](ArchiveError.md)

## Constructors

### new ExceedSizeLimitError()

> **new ExceedSizeLimitError**(`message`?): [`ExceedSizeLimitError`](ExceedSizeLimitError.md)
#### Parameters

**message?**: `string`

Error message

#### Returns

[`ExceedSizeLimitError`](ExceedSizeLimitError.md)

#### Overrides

[`ArchiveError`](ArchiveError.md).[`constructor`](ArchiveError.md#constructors)

## Properties

### cause?

> `optional` **cause**: `unknown`
#### Inherited from

[`ArchiveError`](ArchiveError.md).[`cause`](ArchiveError.md#cause)

---

### code

> **code**: `number`
#### Inherited from

[`ArchiveError`](ArchiveError.md).[`code`](ArchiveError.md#code)

---

### message

> **message**: `string`
#### Inherited from

[`ArchiveError`](ArchiveError.md).[`message`](ArchiveError.md#message)

---

### name

> **name**: `string`
#### Inherited from

[`ArchiveError`](ArchiveError.md).[`name`](ArchiveError.md#name)

---

### stack?

> `optional` **stack**: `string`
#### Inherited from

[`ArchiveError`](ArchiveError.md).[`stack`](ArchiveError.md#stack)

---

### prepareStackTrace()?

> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
Optional override for formatting stack traces

#### Parameters

**err**: `Error`

**stackTraces**: `CallSite`[]

#### Returns

`any`

#### See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

[`ArchiveError`](ArchiveError.md).[`prepareStackTrace`](ArchiveError.md#preparestacktrace)

---

### stackTraceLimit

> `static` **stackTraceLimit**: `number`
#### Inherited from

[`ArchiveError`](ArchiveError.md).[`stackTraceLimit`](ArchiveError.md#stacktracelimit)

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
Create .stack property on a target object

#### Parameters

**targetObject**: `object`

**constructorOpt?**: `Function`

#### Returns

`void`

#### Inherited from

[`ArchiveError`](ArchiveError.md).[`captureStackTrace`](ArchiveError.md#capturestacktrace)
Loading

0 comments on commit 4b5af80

Please sign in to comment.