mirror of
https://github.com/amark/gun.git
synced 2025-03-30 15:08:33 +00:00
70eb769209
This helps those who want to contribute to the TypeScript definitions by adding: * a tool called `tsd,` * its corresponding configuration in package.json * a teste file index.test-d.ts Also add a extra line between type definitions to improve readability.
29 lines
1.1 KiB
TypeScript
29 lines
1.1 KiB
TypeScript
import { IGunChainReference } from './chain';
|
|
import { IGunConstructorOptions } from './options';
|
|
import { IGunStaticNode } from './static/node';
|
|
import { IGunStaticSEA } from './static/sea';
|
|
export interface IGunStatic {
|
|
|
|
/**
|
|
* @description
|
|
* no parameters creates a local datastore using the default persistence layer, either localStorage or Radisk.
|
|
* @param options
|
|
* passing a URL creates the above local datastore that also tries to sync with the URL.
|
|
*
|
|
* or you can pass in an array of URLs to sync with multiple peers.
|
|
*/
|
|
<DataType = any>(options?: string | string[] | IGunConstructorOptions): IGunChainReference<DataType, any, 'pre_root'>;
|
|
new <DataType = any>(options?: string | string[] | IGunConstructorOptions): IGunChainReference<DataType, any, 'pre_root'>;
|
|
readonly node: IGunStaticNode;
|
|
|
|
/** @see https://gun.eco/docs/SEA */
|
|
readonly SEA: IGunStaticSEA;
|
|
readonly version: string;
|
|
readonly chain: IGunChainReference;
|
|
readonly log: {
|
|
(...argv: any[]): void;
|
|
once(...argv: any[]): void;
|
|
off: boolean;
|
|
};
|
|
}
|