Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs for fuels-ts packages #116

Merged
merged 1 commit into from
Feb 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/packages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,8 @@ nav_order: 1

## Modules

- [@fuel-ts/abi-coder](fuel-ts-abi-coder/index.md)
- [@fuel-ts/contract](fuel-ts-contract/index.md)
- [@fuel-ts/providers](fuel-ts-providers/index.md)
- [@fuel-ts/transactions](fuel-ts-transactions/index.md)
- [@fuel-ts/wallet](fuel-ts-wallet/index.md)
83 changes: 83 additions & 0 deletions docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
layout: default
title: AbiCoder
parent: "@fuel-ts/abi-coder"
nav_order: 1

---

# Class: AbiCoder

[@fuel-ts/abi-coder](../index.md).AbiCoder

## Constructors

### constructor

• **new AbiCoder**()

#### Defined in

[abi-coder/src/abi-coder.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L20)

## Methods

### decode

▸ **decode**(`types`, `data`): [`DecodedValue`](../index.md#decodedvalue)

#### Parameters

| Name | Type |
| :------ | :------ |
| `types` | readonly (`string` \| `ParamType`)[] |
| `data` | `BytesLike` |

#### Returns

[`DecodedValue`](../index.md#decodedvalue)

#### Defined in

[abi-coder/src/abi-coder.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L67)

___

### encode

▸ **encode**(`types`, `values`): `string`

#### Parameters

| Name | Type |
| :------ | :------ |
| `types` | readonly (`string` \| `ParamType`)[] |
| `values` | readonly [`Values`](../index.md#values)[] |

#### Returns

`string`

#### Defined in

[abi-coder/src/abi-coder.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L54)

___

### getCoder

▸ **getCoder**(`param`): [`Coder`](Coder.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `param` | `ParamType` |

#### Returns

[`Coder`](Coder.md)

#### Defined in

[abi-coder/src/abi-coder.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L24)
175 changes: 175 additions & 0 deletions docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
---
layout: default
title: ArrayCoder
parent: "@fuel-ts/abi-coder"
nav_order: 1

---

# Class: ArrayCoder

[@fuel-ts/abi-coder](../index.md).ArrayCoder

## Hierarchy

- [`Coder`](Coder.md)

↳ **`ArrayCoder`**

## Constructors

### constructor

• **new ArrayCoder**(`coder`, `length`, `localName`)

#### Parameters

| Name | Type |
| :------ | :------ |
| `coder` | [`Coder`](Coder.md) |
| `length` | `number` |
| `localName` | `string` |

#### Overrides

[Coder](Coder.md).[constructor](Coder.md#constructor)

#### Defined in

[abi-coder/src/coders/array.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L12)

## Properties

### coder

• **coder**: [`Coder`](Coder.md)

#### Defined in

[abi-coder/src/coders/array.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L8)

___

### length

• **length**: `number`

#### Defined in

[abi-coder/src/coders/array.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L10)

___

### localName

• `Readonly` **localName**: `string`

#### Inherited from

[Coder](Coder.md).[localName](Coder.md#localname)

#### Defined in

[abi-coder/src/coders/abstract-coder.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L36)

___

### name

• `Readonly` **name**: `string`

#### Inherited from

[Coder](Coder.md).[name](Coder.md#name)

#### Defined in

[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28)

___

### type

• `Readonly` **type**: `string`

#### Inherited from

[Coder](Coder.md).[type](Coder.md#type)

#### Defined in

[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32)

## Methods

### decode

▸ **decode**(`data`, `offset`): [[`DecodedValue`](../index.md#decodedvalue), `number`]

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `Uint8Array` |
| `offset` | `number` |

#### Returns

[[`DecodedValue`](../index.md#decodedvalue), `number`]

#### Overrides

[Coder](Coder.md).[decode](Coder.md#decode)

#### Defined in

[abi-coder/src/coders/array.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L36)

___

### encode

▸ **encode**(`value`): `any`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `string` \| [`Values`](../index.md#values)[] |

#### Returns

`any`

#### Overrides

[Coder](Coder.md).[encode](Coder.md#encode)

#### Defined in

[abi-coder/src/coders/array.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L20)

___

### throwError

▸ **throwError**(`message`, `value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `message` | `string` |
| `value` | `unknown` |

#### Returns

`void`

#### Inherited from

[Coder](Coder.md).[throwError](Coder.md#throwerror)

#### Defined in

[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45)
Loading