Mirroristas/gun
2
0
Fork 0
mirror of https://github.com/amark/gun.git synced 2025-03-30 15:08:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

add options argument to set/put method signatures (#1067)

Browse Source 
* chain.d.ts: add options argument to put & set

* chain.d.ts: set cb may be null when providing opts

Co-authored-by: Norman Reed <norman.s.reed@gmail.com>
This commit is contained in:
nsreed 2021-04-12 01:58:38 -04:00 committed by GitHub
parent 5ca97d88a3
commit 2168e3e2d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
types/chain.d.ts vendored
View File

@ -15,8 +15,9 @@ export interface IGunChainReference<DataType = Record<string, any>, ReferenceKey
* * Traditional arrays are dangerous in real-time apps. Use `gun.set` instead.
*
* @param callback invoked on each acknowledgment
* @param options additional options (used for specifying certs)
*/
put(data: Partial<AlwaysDisallowedType<DisallowPrimitives<IsTop, DisallowArray<DataType>>>>, callback?: AckCallback): IGunChainReference<DataType, ReferenceKey, IsTop>;
put(data: Partial<AlwaysDisallowedType<DisallowPrimitives<IsTop, DisallowArray<DataType>>>>, callback?: AckCallback|null, options?: {opt?:{cert?:string}}): IGunChainReference<DataType, ReferenceKey, IsTop>;
/**
* Where to read data from.
* @param key The key is the ID or property name of the data that you saved from earlier
@ -80,11 +81,14 @@ export interface IGunChainReference<DataType = Record<string, any>, ReferenceKey
* If the item is added twice, it will be merged.
*
* **This means only objects, for now, are supported.**
* @param data the object to add to the set
* @param callback optional function to invoke when the operation is complete
* @param options additional options (used for specifying certs)
*/
set(data: AlwaysDisallowedType<DataType extends Array<infer U> ? U extends {
[key: string]: any;
[key: number]: any;
} ? ArrayOf<DataType> : never : never>, callback?: AckCallback): IGunChainReference<ArrayOf<DataType>>;
} ? ArrayOf<DataType> : never : never>, callback?: AckCallback|null, options?: {opt?:{cert?:string}}): IGunChainReference<ArrayOf<DataType>>;
/**
* Map iterates over each property and item on a node, passing it down the chain,
* behaving like a forEach on your data.