@xylabs/object-model 4.13.3 → 4.13.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/neutral/index.d.ts +38 -44
- package/package.json +7 -7
package/dist/neutral/index.d.ts
CHANGED
|
@@ -1,44 +1,38 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
*
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
export declare interface TypeCheckRequiredConfig extends TypeCheckConfig {
|
|
41
|
-
required: true;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
export { }
|
|
1
|
+
import { TypedKey, TypedValue } from '@xylabs/typeof';
|
|
2
|
+
import { AnyNonPromise } from '@xylabs/promise';
|
|
3
|
+
import { AssertExMessageFunc } from '@xylabs/assert';
|
|
4
|
+
import { Logger } from '@xylabs/logger';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Any object, which means that it does not enforce the set of fields that it has. Extending from AnyObject
|
|
8
|
+
* will result in a type that includes the universal set of field names
|
|
9
|
+
*/
|
|
10
|
+
type AnyObject = Record<TypedKey, unknown>;
|
|
11
|
+
|
|
12
|
+
interface TypeCheckConfig {
|
|
13
|
+
log?: boolean | Logger;
|
|
14
|
+
}
|
|
15
|
+
interface TypeCheckRequiredConfig extends TypeCheckConfig {
|
|
16
|
+
required: true;
|
|
17
|
+
}
|
|
18
|
+
interface TypeCheckOptionalConfig extends TypeCheckConfig {
|
|
19
|
+
required: false;
|
|
20
|
+
}
|
|
21
|
+
type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
|
|
22
|
+
type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T;
|
|
23
|
+
|
|
24
|
+
type AsTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
|
|
25
|
+
<TType extends T>(value: AnyNonPromise): TType | undefined;
|
|
26
|
+
<TType extends T>(value: AnyNonPromise, config: TypeCheckRequiredConfig): TType;
|
|
27
|
+
<TType extends T>(value: AnyNonPromise, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
|
|
28
|
+
<TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>): TType | undefined;
|
|
29
|
+
<TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckRequiredConfig): TType;
|
|
30
|
+
<TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
|
|
31
|
+
};
|
|
32
|
+
type AsOptionalTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
|
|
33
|
+
<TType extends T>(value: AnyNonPromise): TType | undefined;
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
type Compare<T> = (a: T, b: T) => number;
|
|
37
|
+
|
|
38
|
+
export type { AnyObject, AsOptionalTypeFunction, AsTypeFunction, Compare, StringOrAlertFunction, TypeCheck, TypeCheckConfig, TypeCheckOptionalConfig, TypeCheckRequiredConfig };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/object-model",
|
|
3
|
-
"version": "4.13.
|
|
3
|
+
"version": "4.13.5",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -29,14 +29,14 @@
|
|
|
29
29
|
"module": "dist/neutral/index.mjs",
|
|
30
30
|
"types": "dist/neutral/index.d.ts",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@xylabs/assert": "^4.13.
|
|
33
|
-
"@xylabs/logger": "^4.13.
|
|
34
|
-
"@xylabs/promise": "^4.13.
|
|
35
|
-
"@xylabs/typeof": "^4.13.
|
|
32
|
+
"@xylabs/assert": "^4.13.5",
|
|
33
|
+
"@xylabs/logger": "^4.13.5",
|
|
34
|
+
"@xylabs/promise": "^4.13.5",
|
|
35
|
+
"@xylabs/typeof": "^4.13.5"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@xylabs/ts-scripts-yarn3": "^7.0.0-rc.
|
|
39
|
-
"@xylabs/tsconfig": "^7.0.0-rc.
|
|
38
|
+
"@xylabs/ts-scripts-yarn3": "^7.0.0-rc.8",
|
|
39
|
+
"@xylabs/tsconfig": "^7.0.0-rc.8",
|
|
40
40
|
"typescript": "^5.8.3",
|
|
41
41
|
"vitest": "^3.2.4"
|
|
42
42
|
},
|