Skip to content

Commit 22a6e2c

Browse files
authored
feat: postage stamps and other tweaks (#67)
1 parent 595ccce commit 22a6e2c

File tree

153 files changed

+24176
-11074
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

153 files changed

+24176
-11074
lines changed

docs/api/_category_.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
label: "API"

docs/api/classes/_category_.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
label: "Classes"
2+
position: 3

docs/api/classes/bee.md

Lines changed: 557 additions & 272 deletions
Large diffs are not rendered by default.

docs/api/classes/beeargumenterror.md

Lines changed: 86 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,108 +2,153 @@
22
id: "beeargumenterror"
33
title: "Class: BeeArgumentError"
44
sidebar_label: "BeeArgumentError"
5+
sidebar_position: 0
56
custom_edit_url: null
6-
hide_title: true
77
---
88

9-
# Class: BeeArgumentError
10-
119
## Hierarchy
1210

13-
* [*BeeError*](beeerror.md)
11+
- [`BeeError`](beeerror.md)
1412

15-
**BeeArgumentError**
13+
**`BeeArgumentError`**
1614

1715
## Constructors
1816

1917
### constructor
2018

21-
\+ **new BeeArgumentError**(`message`: *string*, `value`: *unknown*): [*BeeArgumentError*](beeargumenterror.md)
19+
**new BeeArgumentError**(`message`, `value`)
20+
21+
#### Parameters
2222

23-
#### Parameters:
23+
| Name | Type |
24+
| :------ | :------ |
25+
| `message` | `string` |
26+
| `value` | `unknown` |
2427

25-
Name | Type |
26-
:------ | :------ |
27-
`message` | *string* |
28-
`value` | *unknown* |
28+
#### Overrides
2929

30-
**Returns:** [*BeeArgumentError*](beeargumenterror.md)
30+
[BeeError](beeerror.md).[constructor](beeerror.md#constructor)
3131

32-
Inherited from: [BeeError](beeerror.md)
32+
#### Defined in
3333

34-
Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/430becc/src/utils/error.ts#L7)
34+
[bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/0e69ca1/src/utils/error.ts#L7)
3535

3636
## Properties
3737

3838
### message
3939

40-
**message**: *string*
40+
**message**: `string`
41+
42+
#### Inherited from
43+
44+
[BeeError](beeerror.md).[message](beeerror.md#message)
4145

42-
Inherited from: [BeeError](beeerror.md).[message](beeerror.md#message)
46+
#### Defined in
4347

44-
Defined in: node_modules/typescript/lib/lib.es5.d.ts:974
48+
node_modules/typescript/lib/lib.es5.d.ts:974
4549

4650
___
4751

4852
### name
4953

50-
**name**: *string*
54+
**name**: `string`
55+
56+
#### Inherited from
57+
58+
[BeeError](beeerror.md).[name](beeerror.md#name)
59+
60+
#### Defined in
61+
62+
node_modules/typescript/lib/lib.es5.d.ts:973
5163

52-
Inherited from: [BeeError](beeerror.md).[name](beeerror.md#name)
64+
___
65+
66+
### stack
67+
68+
`Optional` **stack**: `string`
5369

54-
Defined in: node_modules/typescript/lib/lib.es5.d.ts:973
70+
#### Inherited from
71+
72+
[BeeError](beeerror.md).[stack](beeerror.md#stack)
73+
74+
#### Defined in
75+
76+
node_modules/typescript/lib/lib.es5.d.ts:975
77+
78+
___
79+
80+
### value
81+
82+
`Readonly` **value**: `unknown`
5583

5684
___
5785

5886
### prepareStackTrace
5987

60-
`Optional` **prepareStackTrace**: *undefined* \| (`err`: Error, `stackTraces`: CallSite[]) =\> *any*
88+
`Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) =\> `any`
89+
90+
#### Type declaration
91+
92+
▸ (`err`, `stackTraces`): `any`
6193

6294
Optional override for formatting stack traces
6395

64-
**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
96+
##### Parameters
6597

66-
Defined in: bee-js/node_modules/@types/node/globals.d.ts:11
98+
| Name | Type |
99+
| :------ | :------ |
100+
| `err` | `Error` |
101+
| `stackTraces` | `CallSite`[] |
67102

68-
___
103+
##### Returns
69104

70-
### stack
105+
`any`
71106

72-
`Optional` **stack**: *undefined* \| *string*
107+
#### Inherited from
73108

74-
Inherited from: [BeeError](beeerror.md).[stack](beeerror.md#stack)
109+
[BeeError](beeerror.md).[prepareStackTrace](beeerror.md#preparestacktrace)
75110

76-
Defined in: node_modules/typescript/lib/lib.es5.d.ts:975
111+
#### Defined in
112+
113+
bee-js/node_modules/@types/node/globals.d.ts:11
77114

78115
___
79116

80117
### stackTraceLimit
81118

82-
**stackTraceLimit**: *number*
119+
`Static` **stackTraceLimit**: `number`
83120

84-
Defined in: bee-js/node_modules/@types/node/globals.d.ts:13
121+
#### Inherited from
85122

86-
___
123+
[BeeError](beeerror.md).[stackTraceLimit](beeerror.md#stacktracelimit)
87124

88-
### value
125+
#### Defined in
89126

90-
`Readonly` **value**: *unknown*
127+
bee-js/node_modules/@types/node/globals.d.ts:13
91128

92129
## Methods
93130

94131
### captureStackTrace
95132

96-
**captureStackTrace**(`targetObject`: *object*, `constructorOpt?`: Function): *void*
133+
`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
97134

98135
Create .stack property on a target object
99136

100-
#### Parameters:
137+
#### Parameters
138+
139+
| Name | Type |
140+
| :------ | :------ |
141+
| `targetObject` | `object` |
142+
| `constructorOpt?` | `Function` |
143+
144+
#### Returns
145+
146+
`void`
147+
148+
#### Inherited from
101149

102-
Name | Type |
103-
:------ | :------ |
104-
`targetObject` | *object* |
105-
`constructorOpt?` | Function |
150+
[BeeError](beeerror.md).[captureStackTrace](beeerror.md#capturestacktrace)
106151

107-
**Returns:** *void*
152+
#### Defined in
108153

109-
Defined in: bee-js/node_modules/@types/node/globals.d.ts:4
154+
bee-js/node_modules/@types/node/globals.d.ts:4

0 commit comments

Comments
 (0)