RevelaNetwork/Revela
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

higher quality types for client methods

Browse source
This commit is contained in:
David Reed 2023-06-13 23:06:33 -04:00
parent dd655b938f
commit 4b1acbf3c3
No known key found for this signature in database
GPG key ID: 2211691D8A1EE72F
1 changed files with 32 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/client/index.js
View file

@ -19,6 +19,17 @@ import StyleApi from './dom/style.js';
import IDBApi from './idb.js'; import IDBApi from './idb.js';
import WebSocketApi from './requests/websocket.js'; import WebSocketApi from './requests/websocket.js';
/**
* @template {Function} [T=Function]
* @typedef {(fn: T, that: any, args: any[]) => {}} WrapFun
*/
/**
* @typedef {object} WrapPropertyDescriptor
* @property {WrapFun} [get]
* @property {WrapFun} [set]
*/
class UVClient extends EventEmitter { class UVClient extends EventEmitter {
/** /**
* *
@ -73,9 +84,9 @@ class UVClient extends EventEmitter {
/** /**
* *
* @param {*} obj * @param {*} obj
* @param {*} prop * @param {PropertyKey} prop
* @param {WrapFun} wrapper * @param {WrapFun} wrapper
* @param {*} construct * @param {boolean} [construct]
* @returns * @returns
*/ */
override(obj, prop, wrapper, construct) { override(obj, prop, wrapper, construct) {
@ -84,26 +95,30 @@ class UVClient extends EventEmitter {
obj[prop] = wrapped; obj[prop] = wrapped;
return wrapped; return wrapped;
} }
/**
*
* @param {*} obj
* @param {PropertyKey} prop
* @param {WrapPropertyDescriptor} [wrapObj]
* @returns
*/
overrideDescriptor(obj, prop, wrapObj = {}) { overrideDescriptor(obj, prop, wrapObj = {}) {
const wrapped = this.wrapDescriptor(obj, prop, wrapObj); const wrapped = this.wrapDescriptor(obj, prop, wrapObj);
if (!wrapped) return {}; if (!wrapped) return {};
this.nativeMethods.defineProperty(obj, prop, wrapped); this.nativeMethods.defineProperty(obj, prop, wrapped);
return wrapped; return wrapped;
} }
/**
* @template {Function} [T=Function]
* @typedef {(fn: T, that: any, args: any[]) => {}} WrapFun
*/
/** /**
* *
* @template T * @template T
* @param {*} obj * @param {*} obj
* @param {*} prop * @param {PropertyKey} prop
* @param {WrapFun<T>} wrap * @param {WrapFun<T>} wrap
* @param {boolean} construct * @param {boolean} [construct]
* @returns {T} * @returns {T}
*/ */
wrap(obj, prop, wrap, construct) { wrap(obj, prop, wrap, construct = false) {
const fn = obj[prop]; const fn = obj[prop];
if (!fn) return fn; if (!fn) return fn;
const wrapped = const wrapped =
@ -122,10 +137,17 @@ class UVClient extends EventEmitter {
wrapped.prototype.constructor = wrapped; wrapped.prototype.constructor = wrapped;
} }
this.emit('wrap', fn, wrapped, !!construct); this.emit('wrap', fn, wrapped, construct);
return wrapped; return wrapped;
} }
/**
*
* @param {*} obj
* @param {PropertyKey} prop
* @param {WrapPropertyDescriptor} [wrapObj]
* @returns
*/
wrapDescriptor(obj, prop, wrapObj = {}) { wrapDescriptor(obj, prop, wrapObj = {}) {
const descriptor = this.nativeMethods.getOwnPropertyDescriptor( const descriptor = this.nativeMethods.getOwnPropertyDescriptor(
obj, obj,