@pg-labs-incubator/cobweb 0.0.0-stage → 0.0.2

package/target/tsc/util/preconditions.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Ensure a state is valid.
+ *
+ * @param valid - `true` if, and only if, state is valid
+ * @param msg - failure message
+ * @throws {@link Error} `valid` is `false`
+ */
+export declare function checkState(valid: boolean, msg?: string): asserts valid;
+/**
+ * Ensure execution is within a browser environment.
+ *
+ * @throws {@link Error} not executing within a browser environment
+ * @see {@link checkServer}
+ */
+export declare function checkBrowser(): void;
+/**
+ * Ensure execution is within a server environment.
+ *
+ * @throws {@link Error} not executing within a server environment
+ * @see {@link checkBrowser}
+ */
+export declare function checkServer(): void;
+/**
+ * Ensure an argument is valid.
+ *
+ * @param valid - `true` if, and only if, argument is valid
+ * @param msg - failure message
+ * @throws {@link Error} `valid` is `false`
+ */
+export declare function checkArgument(valid: boolean, msg?: string): asserts valid;
+/**
+ * Ensure a value is not `undefined` and not `null`.
+ *
+ * @typeParam T - expected non-nullish value type
+ * @param val - value to test
+ * @param what - name of value being tested
+ * @throws {@link ReferenceError} `val` is `null` or `undefined`
+ */
+export declare function checkValueDefined<T>(val: T | null | undefined, what?: string): asserts val is T;
+/**
+ * Ensure a value is a `boolean`.
+ *
+ * @param val - value to test
+ * @param what - name of value being tested
+ * @throws {@link TypeError} `val` is not a `boolean`
+ */
+export declare function checkBoolean(val: unknown, what?: string): asserts val is boolean;
+/**
+ * Ensure a value is a `number`.
+ *
+ * @param val - value to test
+ * @param what - name of value being tested
+ * @throws {@link TypeError} `val` is not a `number`
+ */
+export declare function checkNumber(val: unknown, what?: string): asserts val is number;
+/**
+ * Ensure a value is a `string`.
+ *
+ * @param val - value to test
+ * @param what - name of value being tested
+ * @throws {@link TypeError} `val` is not a `string`
+ */
+export declare function checkString(val: unknown, what?: string): asserts val is string;
+/**
+ * Ensure a value is an `object`.
+ *
+ * @param val - value to test
+ * @param what - name of value being tested
+ * @throws {@link TypeError} `val` is not an `object`
+ */
+export declare function checkObject(val: unknown, what?: string): asserts val is object;
+/**
+ * Ensure a value is an array.
+ *
+ * @param val - value to test
+ * @param what - name of value being tested
+ * @throws {@link TypeError} `val` is not an array
+ */
+export declare function checkArray(val: unknown, what?: string): asserts val is unknown[];

package/target/tsc/util/reactive.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Test whether a property is reactive or not.
+ *
+ * @typeParam P - properties type
+ * @typeParam K - property key type
+ * @param props - properties to check in
+ * @param key - key of property to check
+ * @returns `true` if, and only if, `key` has a reactive value in `props`
+ */
+export declare function isPropReactive<P extends object, K extends keyof P>(props: P, key: K): boolean;
+/**
+ * Consume possibly static property values.
+ *
+ * For each key `K` in `optKeys`, this tests whether `K` is assigned a static property value, if
+ * so, the property value is assigned to `K` in the resulting object. A key which `props` does
+ * not define is static, and is assigned `undefined`. A key assigned a {@link isPropReactive |
+ * reactive} value, or any key of a proxy object, is not static, and is not assigned in the
+ * resulting object. For each key `K` in `reqKeys`, this accesses the property value assigned to
+ * `K`, in an {@link solid-js#untrack | untracked} context, and assigns the value to `K` in the
+ * resulting object.
+ *
+ * Consumed property values are read once; they are **not** tracked. `props` is **not**
+ * modified, so properties remain readable after they are consumed. This is required since
+ * SolidJS may pass an object owned by the caller as component properties, for example, the
+ * object of a lone `{...props}` spread, which may be shared with other components, or used again
+ * when a component is constructed again.
+ *
+ * @typeParam P - properties type
+ * @typeParam KO - optional property keys type
+ * @typeParam KR - required property keys type
+ * @param props - properties to consume from
+ * @param optKeys - optional keys to consume
+ * @param reqKeys - required keys to consume
+ * @returns resulting object with consumed property values
+ */
+export declare function consumeProps<P extends object, KO extends (keyof P)[], KR extends (keyof P)[]>(props: P, optKeys: KO, reqKeys?: KR): (Partial<Pick<P, KO[number]>> & Pick<P, KR[number]>);