Skip to content

Commit

Permalink
docs: update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
toyobayashi committed Jan 3, 2024
1 parent d70a1f0 commit 58fc09f
Show file tree
Hide file tree
Showing 378 changed files with 6,704 additions and 6,683 deletions.
24 changes: 12 additions & 12 deletions docs/api/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

| Package | Description |
| --- | --- |
| [@tybys/wz](./wz.md) | MapleStory WZ reader. |

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

| Package | Description |
| --- | --- |
| [@tybys/wz](./wz.md) | MapleStory WZ reader. |

24 changes: 12 additions & 12 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

| Package | Description |
| --- | --- |
| [@tybys/wz](./wz.md) | MapleStory WZ reader. |

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

| Package | Description |
| --- | --- |
| [@tybys/wz](./wz.md) | MapleStory WZ reader. |

40 changes: 20 additions & 20 deletions docs/api/wz.baseerror._constructor_.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [BaseError](./wz.baseerror.md) &gt; [(constructor)](./wz.baseerror._constructor_.md)

## BaseError.(constructor)

Constructs a new instance of the `BaseError` class

<b>Signature:</b>

```typescript
constructor(message?: string);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| message | string | <i>(Optional)</i> |

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [BaseError](./wz.baseerror.md) &gt; [(constructor)](./wz.baseerror._constructor_.md)

## BaseError.(constructor)

Constructs a new instance of the `BaseError` class

**Signature:**

```typescript
constructor(message?: string);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| message | string | _(Optional)_ |

40 changes: 20 additions & 20 deletions docs/api/wz.baseerror.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [BaseError](./wz.baseerror.md)

## BaseError class


<b>Signature:</b>

```typescript
export declare class BaseError extends Error
```
<b>Extends:</b> Error
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(message)](./wz.baseerror._constructor_.md) | | Constructs a new instance of the <code>BaseError</code> class |
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [BaseError](./wz.baseerror.md)

## BaseError class


**Signature:**

```typescript
export declare class BaseError extends Error
```
**Extends:** Error
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(message)](./wz.baseerror._constructor_.md) | | Constructs a new instance of the <code>BaseError</code> class |
42 changes: 21 additions & 21 deletions docs/api/wz.canvas._constructor_.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [(constructor)](./wz.canvas._constructor_.md)

## Canvas.(constructor)

Constructs a new instance of the `Canvas` class

<b>Signature:</b>

```typescript
constructor(width: number, height: number);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| width | number | |
| height | number | |

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [(constructor)](./wz.canvas._constructor_.md)

## Canvas.(constructor)

Constructs a new instance of the `Canvas` class

**Signature:**

```typescript
constructor(width: number, height: number);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| width | number | |
| height | number | |

30 changes: 15 additions & 15 deletions docs/api/wz.canvas.dispose.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [dispose](./wz.canvas.dispose.md)

## Canvas.dispose() method

<b>Signature:</b>

```typescript
dispose(): void;
```
<b>Returns:</b>

void

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [dispose](./wz.canvas.dispose.md)

## Canvas.dispose() method

**Signature:**

```typescript
dispose(): void;
```
**Returns:**

void

44 changes: 22 additions & 22 deletions docs/api/wz.canvas.getbufferasync.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [getBufferAsync](./wz.canvas.getbufferasync.md)

## Canvas.getBufferAsync() method

<b>Signature:</b>

```typescript
getBufferAsync(mime: string): Promise<Uint8Array>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| mime | string | |

<b>Returns:</b>

Promise&lt;Uint8Array&gt;

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [getBufferAsync](./wz.canvas.getbufferasync.md)

## Canvas.getBufferAsync() method

**Signature:**

```typescript
getBufferAsync(mime: string): Promise<Uint8Array>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| mime | string | |

**Returns:**

Promise&lt;Uint8Array&gt;

15 changes: 15 additions & 0 deletions docs/api/wz.canvas.getcanvas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [getCanvas](./wz.canvas.getcanvas.md)

## Canvas.getCanvas() method

**Signature:**

```typescript
getCanvas(): HTMLCanvasElement | InstanceType<typeof Jimp>;
```
**Returns:**

HTMLCanvasElement \| InstanceType&lt;typeof Jimp&gt;

30 changes: 15 additions & 15 deletions docs/api/wz.canvas.getwidth.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [getWidth](./wz.canvas.getwidth.md)

## Canvas.getWidth() method

<b>Signature:</b>

```typescript
getWidth(): number;
```
<b>Returns:</b>

number

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md) &gt; [getWidth](./wz.canvas.getwidth.md)

## Canvas.getWidth() method

**Signature:**

```typescript
getWidth(): number;
```
**Returns:**

number

61 changes: 31 additions & 30 deletions docs/api/wz.canvas.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md)

## Canvas class


<b>Signature:</b>

```typescript
export declare class Canvas
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(width, height)](./wz.canvas._constructor_.md) | | Constructs a new instance of the <code>Canvas</code> class |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [dispose()](./wz.canvas.dispose.md) | | |
| [getBufferAsync(mime)](./wz.canvas.getbufferasync.md) | | |
| [getWidth()](./wz.canvas.getwidth.md) | | |
| [rgbaToInt(r, g, b, a)](./wz.canvas.rgbatoint.md) | <code>static</code> | |
| [setPixelColor(rgba, x, y)](./wz.canvas.setpixelcolor.md) | | |
| [writeAsync(file)](./wz.canvas.writeasync.md) | | |

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tybys/wz](./wz.md) &gt; [Canvas](./wz.canvas.md)

## Canvas class


**Signature:**

```typescript
export declare class Canvas
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(width, height)](./wz.canvas._constructor_.md) | | Constructs a new instance of the <code>Canvas</code> class |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [dispose()](./wz.canvas.dispose.md) | | |
| [getBufferAsync(mime)](./wz.canvas.getbufferasync.md) | | |
| [getCanvas()](./wz.canvas.getcanvas.md) | | |
| [getWidth()](./wz.canvas.getwidth.md) | | |
| [rgbaToInt(r, g, b, a)](./wz.canvas.rgbatoint.md) | <code>static</code> | |
| [setPixelColor(rgba, x, y)](./wz.canvas.setpixelcolor.md) | | |
| [writeAsync(file)](./wz.canvas.writeasync.md) | | |

Loading

0 comments on commit 58fc09f

Please sign in to comment.