Skip to content
This repository was archived by the owner on Apr 6, 2020. It is now read-only.

Commit 82d057a

Browse files
committed
Replace private modifiers for tsdocs @hidden tags
1 parent c93b4dd commit 82d057a

File tree

2 files changed

+138
-51
lines changed

2 files changed

+138
-51
lines changed

docs/classes/blockchain.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ new Blockchain({ db: db }).iterator(
7676

7777
**new Blockchain**(opts?: _`any`_): [Blockchain](blockchain.md)
7878

79-
_Defined in [index.ts:73](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L73)_
79+
_Defined in [index.ts:112](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L112)_
8080

8181
Creates new Blockchain object
8282

@@ -110,7 +110,7 @@ The old separated DB constructor parameters `opts.blockDB` and `opts.detailsDB`
110110

111111
**● db**: _`any`_
112112

113-
_Defined in [index.ts:66](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L66)_
113+
_Defined in [index.ts:105](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L105)_
114114

115115
---
116116

@@ -120,7 +120,7 @@ _Defined in [index.ts:66](https://github.com/ethereumjs/ethereumjs-blockchain/bl
120120

121121
**● dbManager**: _`DBManager`_
122122

123-
_Defined in [index.ts:67](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L67)_
123+
_Defined in [index.ts:106](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L106)_
124124

125125
---
126126

@@ -130,7 +130,7 @@ _Defined in [index.ts:67](https://github.com/ethereumjs/ethereumjs-blockchain/bl
130130

131131
**● ethash**: _`any`_
132132

133-
_Defined in [index.ts:68](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L68)_
133+
_Defined in [index.ts:107](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L107)_
134134

135135
---
136136

@@ -140,7 +140,7 @@ _Defined in [index.ts:68](https://github.com/ethereumjs/ethereumjs-blockchain/bl
140140

141141
**● validate**: _`boolean`_
142142

143-
_Defined in [index.ts:73](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L73)_
143+
_Defined in [index.ts:112](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L112)_
144144

145145
A flag indicating if this Blockchain validates blocks or not.
146146

@@ -154,7 +154,7 @@ A flag indicating if this Blockchain validates blocks or not.
154154

155155
**get meta**(): `object`
156156

157-
_Defined in [index.ts:136](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L136)_
157+
_Defined in [index.ts:175](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L175)_
158158

159159
Returns an object with metadata about the Blockchain. It's defined for backwards compatibility.
160160

@@ -170,7 +170,7 @@ Returns an object with metadata about the Blockchain. It's defined for backwards
170170

171171
**delBlock**(blockHash: _`Buffer`_, cb: _`any`_): `void`
172172

173-
_Defined in [index.ts:762](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L762)_
173+
_Defined in [index.ts:823](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L823)_
174174

175175
Deletes a block from the blockchain. All child blocks in the chain are deleted and any encountered heads are set to the parent block.
176176

@@ -191,7 +191,7 @@ Deletes a block from the blockchain. All child blocks in the chain are deleted a
191191

192192
**getBlock**(blockTag: _`Buffer` \| `number` \| `BN`_, cb: _`any`_): `void`
193193

194-
_Defined in [index.ts:514](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L514)_
194+
_Defined in [index.ts:560](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L560)_
195195

196196
Gets a block by its hash.
197197

@@ -212,7 +212,7 @@ Gets a block by its hash.
212212

213213
**getBlocks**(blockId: _`Buffer` \| `number`_, maxBlocks: _`number`_, skip: _`number`_, reverse: _`boolean`_, cb: _`any`_): `void`
214214

215-
_Defined in [index.ts:534](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L534)_
215+
_Defined in [index.ts:583](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L583)_
216216

217217
Looks up many blocks relative to blockId
218218

@@ -236,7 +236,7 @@ Looks up many blocks relative to blockId
236236

237237
**getDetails**(\_: _`string`_, cb: _`any`_): `void`
238238

239-
_Defined in [index.ts:575](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L575)_
239+
_Defined in [index.ts:624](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L624)_
240240

241241
This method used to return block details by its hash. It's only here for backwards compatibility.
242242

@@ -259,7 +259,7 @@ _**deprecated**_:
259259

260260
**getHead**(name: _`any`_, cb?: _`any`_): `void`
261261

262-
_Defined in [index.ts:228](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L228)_
262+
_Defined in [index.ts:271](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L271)_
263263

264264
Returns the specified iterator head.
265265

@@ -280,7 +280,7 @@ Returns the specified iterator head.
280280

281281
**getLatestBlock**(cb: _`any`_): `void`
282282

283-
_Defined in [index.ts:268](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L268)_
283+
_Defined in [index.ts:311](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L311)_
284284

285285
Returns the latest full block in the canonical chain.
286286

@@ -300,7 +300,7 @@ Returns the latest full block in the canonical chain.
300300

301301
**getLatestHeader**(cb: _`any`_): `void`
302302

303-
_Defined in [index.ts:251](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L251)_
303+
_Defined in [index.ts:294](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L294)_
304304

305305
Returns the latest header in the canonical chain.
306306

@@ -320,7 +320,7 @@ Returns the latest header in the canonical chain.
320320

321321
**iterator**(name: _`string`_, onBlock: _`any`_, cb: _`any`_): `void`
322322

323-
_Defined in [index.ts:890](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L890)_
323+
_Defined in [index.ts:957](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L957)_
324324

325325
Iterates through blocks starting at the specified iterator head and calls the onBlock function on each block. The current location of an iterator head can be retrieved using the `getHead()` method.
326326

@@ -342,7 +342,7 @@ Iterates through blocks starting at the specified iterator head and calls the on
342342

343343
**putBlock**(block: _`object`_, cb: _`any`_, isGenesis?: _`undefined` \| `false` \| `true`_): `void`
344344

345-
_Defined in [index.ts:297](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L297)_
345+
_Defined in [index.ts:340](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L340)_
346346

347347
Adds a block to the blockchain.
348348

@@ -364,7 +364,7 @@ Adds a block to the blockchain.
364364

365365
**putBlocks**(blocks: _`Array`<`any`>_, cb: _`any`_): `void`
366366

367-
_Defined in [index.ts:281](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L281)_
367+
_Defined in [index.ts:324](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L324)_
368368

369369
Adds many blocks to the blockchain.
370370

@@ -385,7 +385,7 @@ Adds many blocks to the blockchain.
385385

386386
**putGenesis**(genesis: _`any`_, cb: _`any`_): `void`
387387

388-
_Defined in [index.ts:218](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L218)_
388+
_Defined in [index.ts:261](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L261)_
389389

390390
Puts the genesis block in the database
391391

@@ -406,7 +406,7 @@ Puts the genesis block in the database
406406

407407
**putHeader**(header: _`object`_, cb: _`any`_): `void`
408408

409-
_Defined in [index.ts:329](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L329)_
409+
_Defined in [index.ts:372](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L372)_
410410

411411
Adds a header to the blockchain.
412412

@@ -427,7 +427,7 @@ Adds a header to the blockchain.
427427

428428
**putHeaders**(headers: _`Array`<`any`>_, cb: _`any`_): `void`
429429

430-
_Defined in [index.ts:313](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L313)_
430+
_Defined in [index.ts:356](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L356)_
431431

432432
Adds many headers to the blockchain.
433433

@@ -448,7 +448,7 @@ Adds many headers to the blockchain.
448448

449449
**selectNeededHashes**(hashes: _`Array`<`any`>_, cb: _`any`_): `void`
450450

451-
_Defined in [index.ts:585](https://github.com/ethereumjs/ethereumjs-blockchain/blob/6e88434/src/index.ts#L585)_
451+
_Defined in [index.ts:634](https://github.com/ethereumjs/ethereumjs-blockchain/blob/c93b4dd/src/index.ts#L634)_
452452

453453
Given an ordered array, returns to the callback an array of hashes that are not in the blockchain yet.
454454

0 commit comments

Comments
 (0)