Api-Derives documentation generator (#6099)
* Initial Readme * Initial Readme * expand accounts derive docs * parse and render derives documentation * write to docs/derives * Add code docs * Lint * Temporarily simplify derives Readme * Remove unnecesary export * Regenerate yarn.lock * Improve Derives description
This commit is contained in:
@@ -14,7 +14,7 @@ import { memo } from '../util/index.js';
|
||||
|
||||
/**
|
||||
* @name accountId
|
||||
* @param {(Address | AccountId | AccountIndex | string | null)} address - An accounts address in various formats.
|
||||
* @param {(Address | AccountId | AccountIndex | string | null)} address An accounts address in various formats.
|
||||
* @description An [[AccountId]]
|
||||
*/
|
||||
export function accountId (instanceId: string, api: DeriveApi): (address?: Address | AccountId | AccountIndex | string | null) => Observable<AccountId> {
|
||||
|
||||
@@ -29,7 +29,7 @@ function retrieveNick (api: DeriveApi, accountId?: AccountId): Observable<string
|
||||
|
||||
/**
|
||||
* @name info
|
||||
* @description Returns aux. info with regards to an account, current that includes the accountId, accountIndex and nickname
|
||||
* @description Returns aux. info with regards to an account, current that includes the accountId, accountIndex, identity and nickname
|
||||
*/
|
||||
export function info (instanceId: string, api: DeriveApi): (address?: AccountIndex | AccountId | Address | Uint8Array | string | null) => Observable<DeriveAccountInfo> {
|
||||
return memo(instanceId, (address?: AccountIndex | AccountId | Address | Uint8Array | string | null): Observable<DeriveAccountInfo> =>
|
||||
|
||||
Reference in New Issue
Block a user