From ad9d21cae2be57047ffe3f52e5a3090768b45ab4 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Tue, 10 Sep 2019 20:23:37 +0200 Subject: [PATCH] Remove outdated blockNumber refs. in API docs (#1382) * Remove outdated blockNumber refs * ExtendedHeader * Update subscribeNewHeads.ts --- packages/api-derive/src/chain/subscribeNewHeads.ts | 4 ++-- packages/api/README.md | 4 ++-- packages/rpc-core/README.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/api-derive/src/chain/subscribeNewHeads.ts b/packages/api-derive/src/chain/subscribeNewHeads.ts index 6207639fe1..1d40e187ff 100644 --- a/packages/api-derive/src/chain/subscribeNewHeads.ts +++ b/packages/api-derive/src/chain/subscribeNewHeads.ts @@ -21,8 +21,8 @@ export type HeaderAndValidators = [Header, AccountId[]]; *
* * ```javascript - * api.derive.chain.subscribeNewHeads(({ author, blockNumber }) => { - * console.log(`block #${blockNumber} was authored by ${author}`); + * api.derive.chain.subscribeNewHeads((header) => { + * console.log(`block #${header.number} was authored by ${header.author}`); * }); * ``` */ diff --git a/packages/api/README.md b/packages/api/README.md index 7e89636ca4..cf18f83c1b 100644 --- a/packages/api/README.md +++ b/packages/api/README.md @@ -46,7 +46,7 @@ const api = await ApiPromise.create(); // make a call to retrieve the current network head api.rpc.chain.subscribeNewHeads((header) => { - console.log(`Chain is at #${header.blockNumber}`); + console.log(`Chain is at #${header.number}`); }); ``` @@ -60,7 +60,7 @@ const api = await ApiRx.create().toPromise(); // make a call to retrieve the current network head api.rpc.chain.subscribeNewHeads().subscribe((header) => { - console.log(`Chain is at #${header.blockNumber}`); + console.log(`Chain is at #${header.number}`); }); ``` diff --git a/packages/rpc-core/README.md b/packages/rpc-core/README.md index 1510cd4230..c115e1483b 100644 --- a/packages/rpc-core/README.md +++ b/packages/rpc-core/README.md @@ -43,7 +43,7 @@ rpc.chain ) .subscribe( (header) => { - console.log(`best #${header.blockNumber.toString()}`); + console.log(`best #${header.number.toString()}`); console.log(`parentHash: ${header.parentHash.toString()}`); console.log(`stateRoot: ${header.stateRoot.toString()}`); console.log(`extrinsicsRoot: ${header.extrinsicsRoot.toString()}`); @@ -63,7 +63,7 @@ rpc .subscribeNewHeads() .subscribe( (header) => { - console.log(`best #${header.blockNumber}`); + console.log(`best #${header.number}`); }, (error) => { console.error('error subscribing:', error);