@twin.org/entity 0.0.1-next.17 → 0.0.1-next.19

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.
Files changed (9) hide show
  1. package/docs/changelog.md +1 -1
  2. package/docs/reference/classes/DecoratorHelper.md +9 -3
  3. package/docs/reference/classes/EntityConditions.md +12 -4
  4. package/docs/reference/classes/EntitySchemaHelper.md +15 -5
  5. package/docs/reference/classes/EntitySorter.md +21 -7
  6. package/docs/reference/functions/entity.md +3 -1
  7. package/docs/reference/functions/property.md +3 -1
  8. package/docs/reference/variables/EntitySchemaFactory.md +1 -1
  9. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/entity - Changelog
2
2
 
3
- ## 0.0.1-next.17
3
+ ## 0.0.1-next.19
4
4
 
5
5
  - Initial Release
package/docs/reference/classes/DecoratorHelper.md CHANGED
@@ -26,7 +26,9 @@ Get the schema from the reflection metadata.
26
26
 
27
27
  #### Parameters
28
28
 
29
- • **target**: `any`
29
+ ##### target
30
+
31
+ `any`
30
32
 
31
33
  The object to get the schema data from.
32
34
 
@@ -50,11 +52,15 @@ Set the schema from the reflection metadata.
50
52
 
51
53
  #### Parameters
52
54
 
53
- • **target**: `any`
55
+ ##### target
56
+
57
+ `any`
54
58
 
55
59
  The object to get the schema data from.
56
60
 
57
- • **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
61
+ ##### entitySchema
62
+
63
+ [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
58
64
 
59
65
  The schema to set.
60
66
 
package/docs/reference/classes/EntityConditions.md CHANGED
@@ -26,11 +26,15 @@ See if the entity matches the conditions.
26
26
 
27
27
  #### Parameters
28
28
 
29
- • **entity**: `T`
29
+ ##### entity
30
+
31
+ `T`
30
32
 
31
33
  The entity to test.
32
34
 
33
- • **condition?**: [`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>
35
+ ##### condition?
36
+
37
+ [`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>
34
38
 
35
39
  The conditions to test.
36
40
 
@@ -54,11 +58,15 @@ See if the entity matches the conditions.
54
58
 
55
59
  #### Parameters
56
60
 
57
- • **entity**: `T`
61
+ ##### entity
62
+
63
+ `T`
58
64
 
59
65
  The entity to test.
60
66
 
61
- • **comparator**: [`IComparator`](../interfaces/IComparator.md)
67
+ ##### comparator
68
+
69
+ [`IComparator`](../interfaces/IComparator.md)
62
70
 
63
71
  The condition to test.
64
72
 
package/docs/reference/classes/EntitySchemaHelper.md CHANGED
@@ -26,7 +26,9 @@ Get the schema for the specified object.
26
26
 
27
27
  #### Parameters
28
28
 
29
- • **target**: `any`
29
+ ##### target
30
+
31
+ `any`
30
32
 
31
33
  The object to get the schema data for.
32
34
 
@@ -50,7 +52,9 @@ Get the primary key from the entity schema.
50
52
 
51
53
  #### Parameters
52
54
 
53
- • **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
55
+ ##### entitySchema
56
+
57
+ [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
54
58
 
55
59
  The entity schema to find the primary key from.
56
60
 
@@ -78,7 +82,9 @@ Get the sort properties from the schema.
78
82
 
79
83
  #### Parameters
80
84
 
81
- • **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
85
+ ##### entitySchema
86
+
87
+ [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
82
88
 
83
89
  The entity schema to find the primary key from.
84
90
 
@@ -102,11 +108,15 @@ Build sort properties from the schema and override if necessary.
102
108
 
103
109
  #### Parameters
104
110
 
105
- • **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
111
+ ##### entitySchema
112
+
113
+ [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
106
114
 
107
115
  The entity schema to retrieve the default sort keys.
108
116
 
109
- • **overrideSortKeys?**: `object`[]
117
+ ##### overrideSortKeys?
118
+
119
+ `object`[]
110
120
 
111
121
  The override sort keys.
112
122
 
package/docs/reference/classes/EntitySorter.md CHANGED
@@ -26,11 +26,15 @@ Sort a list of entities using multiple keys and direction.
26
26
 
27
27
  #### Parameters
28
28
 
29
- • **entities**: `T`[]
29
+ ##### entities
30
+
31
+ `T`[]
30
32
 
31
33
  The list of entities.
32
34
 
33
- • **entitySorters?**: [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
35
+ ##### entitySorters?
36
+
37
+ [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
34
38
 
35
39
  The sort keys to use.
36
40
 
@@ -54,23 +58,33 @@ Compare two properties.
54
58
 
55
59
  #### Parameters
56
60
 
57
- • **entity1**: `T`
61
+ ##### entity1
62
+
63
+ `T`
58
64
 
59
65
  The first entity.
60
66
 
61
- • **entity2**: `T`
67
+ ##### entity2
68
+
69
+ `T`
62
70
 
63
71
  The second entity.
64
72
 
65
- • **prop**: keyof `T`
73
+ ##### prop
74
+
75
+ keyof `T`
66
76
 
67
77
  The property to compare.
68
78
 
69
- • **type**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
79
+ ##### type
80
+
81
+ [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
70
82
 
71
83
  The type of the property.
72
84
 
73
- • **direction**: [`SortDirection`](../type-aliases/SortDirection.md) = `SortDirection.Ascending`
85
+ ##### direction
86
+
87
+ [`SortDirection`](../type-aliases/SortDirection.md) = `SortDirection.Ascending`
74
88
 
75
89
  The direction of the sort.
76
90
 
package/docs/reference/functions/entity.md CHANGED
@@ -6,7 +6,9 @@ Decorator to produce schema data for entity.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **options?**: [`IEntitySchemaOptions`](../interfaces/IEntitySchemaOptions.md)
9
+ ### options?
10
+
11
+ [`IEntitySchemaOptions`](../interfaces/IEntitySchemaOptions.md)
10
12
 
11
13
  The options for the entity.
12
14
 
package/docs/reference/functions/property.md CHANGED
@@ -6,7 +6,9 @@ Decorator to produce schema property data for entities.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **options**: `Omit`\<[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`unknown`\>, `"property"`\>
9
+ ### options
10
+
11
+ `Omit`\<[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md), `"property"`\>
10
12
 
11
13
  The options for the property.
12
14
 
package/docs/reference/variables/EntitySchemaFactory.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Variable: EntitySchemaFactory
2
2
 
3
- > `const` **EntitySchemaFactory**: `Factory`\<[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`unknown`\>\>
3
+ > `const` **EntitySchemaFactory**: `Factory`\<[`IEntitySchema`](../interfaces/IEntitySchema.md)\>
4
4
 
5
5
  Factory for creating entity schemas.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/entity",
3
- "version": "0.0.1-next.17",
3
+ "version": "0.0.1-next.19",
4
4
  "description": "Helpers for defining and working with entities",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.1-next.17",
17
+ "@twin.org/core": "0.0.1-next.19",
18
18
  "@twin.org/nameof": "next",
19
19
  "reflect-metadata": "0.2.2"
20
20
  },