Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
dc5ac4139b
81 changed files with 5 additions and 10 deletions
  1. 0 5
      README.md
  2. 0 0
      docs/classes/Adapter.html
  3. 0 0
      docs/classes/AdapterLoader.html
  4. 0 0
      docs/classes/AdapterRegistry.html
  5. 0 0
      docs/classes/BelongsToResolver.html
  6. 0 0
      docs/classes/DatasourceDefinitionValidator.html
  7. 0 0
      docs/classes/DefinitionRegistry.html
  8. 0 0
      docs/classes/FieldsClauseTool.html
  9. 0 0
      docs/classes/HasManyResolver.html
  10. 0 0
      docs/classes/HasOneResolver.html
  11. 0 0
      docs/classes/IncludeClauseTool.html
  12. 0 0
      docs/classes/InvalidArgumentError.html
  13. 0 0
      docs/classes/InvalidOperatorValueError.html
  14. 0 0
      docs/classes/ModelDataSanitizer.html
  15. 0 0
      docs/classes/ModelDataValidator.html
  16. 0 0
      docs/classes/ModelDefinitionUtils.html
  17. 0 0
      docs/classes/ModelDefinitionValidator.html
  18. 0 0
      docs/classes/NotImplementedError.html
  19. 0 0
      docs/classes/OperatorClauseTool.html
  20. 0 0
      docs/classes/OrderClauseTool.html
  21. 0 0
      docs/classes/PrimaryKeysDefinitionValidator.html
  22. 0 0
      docs/classes/PropertiesDefinitionValidator.html
  23. 0 0
      docs/classes/ReferencesManyResolver.html
  24. 0 0
      docs/classes/RelationsDefinitionValidator.html
  25. 0 0
      docs/classes/Repository.html
  26. 0 0
      docs/classes/RepositoryRegistry.html
  27. 0 0
      docs/classes/Schema.html
  28. 0 0
      docs/classes/SliceClauseTool.html
  29. 0 0
      docs/classes/WhereClauseTool.html
  30. 0 0
      docs/enums/DataType.html
  31. 0 0
      docs/enums/RelationType.html
  32. 0 0
      docs/functions/capitalize.html
  33. 0 0
      docs/functions/cloneDeep.html
  34. 0 0
      docs/functions/excludeObjectKeys.html
  35. 0 0
      docs/functions/getCtorName.html
  36. 0 0
      docs/functions/getValueByPath.html
  37. 0 0
      docs/functions/isCtor.html
  38. 0 0
      docs/functions/isPureObject.html
  39. 0 0
      docs/functions/selectObjectKeys.html
  40. 0 0
      docs/functions/singularize.html
  41. 0 0
      docs/functions/stringToRegexp.html
  42. 5 5
      docs/index.html
  43. 0 0
      docs/interfaces/AndClause.html
  44. 0 0
      docs/interfaces/OrClause.html
  45. 0 0
      docs/types/AnyObject.html
  46. 0 0
      docs/types/BelongsToDefinition.html
  47. 0 0
      docs/types/DEFAULT_PRIMARY_KEY_PROPERTY_NAME.html
  48. 0 0
      docs/types/DatasourceDefinition.html
  49. 0 0
      docs/types/FieldsClause.html
  50. 0 0
      docs/types/FilterClause.html
  51. 0 0
      docs/types/Flatten.html
  52. 0 0
      docs/types/FullPropertyDefinition.html
  53. 0 0
      docs/types/HasManyDefinition.html
  54. 0 0
      docs/types/HasOneDefinition.html
  55. 0 0
      docs/types/Identity.html
  56. 0 0
      docs/types/IncludeClause.html
  57. 0 0
      docs/types/ItemFilterClause.html
  58. 0 0
      docs/types/ModelData.html
  59. 0 0
      docs/types/ModelDefinition.html
  60. 0 0
      docs/types/ModelId.html
  61. 0 0
      docs/types/NestedIncludeClause.html
  62. 0 0
      docs/types/NormalizedFieldsClause.html
  63. 0 0
      docs/types/NormalizedIncludeClause.html
  64. 0 0
      docs/types/OperatorClause.html
  65. 0 0
      docs/types/OptionalUnlessRequiredId.html
  66. 0 0
      docs/types/OrderClause.html
  67. 0 0
      docs/types/PartialBy.html
  68. 0 0
      docs/types/PartialWithoutId.html
  69. 0 0
      docs/types/PolyBelongsToDefinition.html
  70. 0 0
      docs/types/PolyHasManyDefinitionWithTargetKeys.html
  71. 0 0
      docs/types/PolyHasManyDefinitionWithTargetRelationName.html
  72. 0 0
      docs/types/PolyHasOneDefinitionWithTargetKeys.html
  73. 0 0
      docs/types/PolyHasOneDefinitionWithTargetRelationName.html
  74. 0 0
      docs/types/PropertiesClause.html
  75. 0 0
      docs/types/PropertyDefinition.html
  76. 0 0
      docs/types/PropertyDefinitionMap.html
  77. 0 0
      docs/types/ReferencesManyDefinition.html
  78. 0 0
      docs/types/RelationDefinition.html
  79. 0 0
      docs/types/RelationDefinitionMap.html
  80. 0 0
      docs/types/WhereClause.html
  81. 0 0
      docs/types/WithoutId.html

+ 0 - 5
README.md

@@ -303,7 +303,6 @@ schema.defineModel({
 Подсчет документов методом `count` согласно условиям выборки.
 
 ```js
-// count(where)
 const res = await rep.count({
   authorId: 251,
   publishedAt: {
@@ -315,7 +314,6 @@ const res = await rep.count({
 Удаление документов методом `delete` с применением оператора `or`
 
 ```js
-// delete(where)
 const res = await rep.delete({
   or: [
     {sent: false},
@@ -334,7 +332,6 @@ const res = await rep.delete({
 Упорядочить по свойству `createdAt`
 
 ```js
-// find(filter)
 const res = await rep.find({
   order: 'createdAt',
 });
@@ -343,7 +340,6 @@ const res = await rep.find({
 Упорядочить по свойству `createdAt` в обратном порядке.
 
 ```js
-// find(filter)
 const res = await rep.find({
   order: 'createdAt DESC',
 });
@@ -352,7 +348,6 @@ const res = await rep.find({
 Упорядочить по нескольким свойствам в разных направлениях.
 
 ```js
-// find(filter)
 const res = await rep.find({
   order: [
     'title',

File diff suppressed because it is too large
+ 0 - 0
docs/classes/Adapter.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/AdapterLoader.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/AdapterRegistry.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/BelongsToResolver.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/DatasourceDefinitionValidator.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/DefinitionRegistry.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/FieldsClauseTool.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/HasManyResolver.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/HasOneResolver.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/IncludeClauseTool.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/InvalidArgumentError.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/InvalidOperatorValueError.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/ModelDataSanitizer.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/ModelDataValidator.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/ModelDefinitionUtils.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/ModelDefinitionValidator.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/NotImplementedError.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/OperatorClauseTool.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/OrderClauseTool.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/PrimaryKeysDefinitionValidator.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/PropertiesDefinitionValidator.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/ReferencesManyResolver.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/RelationsDefinitionValidator.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/Repository.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/RepositoryRegistry.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/Schema.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/SliceClauseTool.html


File diff suppressed because it is too large
+ 0 - 0
docs/classes/WhereClauseTool.html


File diff suppressed because it is too large
+ 0 - 0
docs/enums/DataType.html


File diff suppressed because it is too large
+ 0 - 0
docs/enums/RelationType.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/capitalize.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/cloneDeep.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/excludeObjectKeys.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/getCtorName.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/getValueByPath.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/isCtor.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/isPureObject.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/selectObjectKeys.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/singularize.html


File diff suppressed because it is too large
+ 0 - 0
docs/functions/stringToRegexp.html


+ 5 - 5
docs/index.html

@@ -156,22 +156,22 @@
 <p><em>i. Условия можно объединять операторами <code>and</code>, <code>or</code> и <code>nor</code>.</em></p>
 <p><strong>Примеры</strong></p>
 <p>Подсчет документов методом <code>count</code> согласно условиям выборки.</p>
-<pre><code class="language-js"><span class="hl-5">// count(where)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">count</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">authorId:</span><span class="hl-1"> </span><span class="hl-8">251</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">publishedAt:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">lte:</span><span class="hl-1"> </span><span class="hl-2">&#39;2023-12-02T14:00:00.000Z&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  },</span><br/><span class="hl-1">});</span>
+<pre><code class="language-js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">count</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">authorId:</span><span class="hl-1"> </span><span class="hl-8">251</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">publishedAt:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">lte:</span><span class="hl-1"> </span><span class="hl-2">&#39;2023-12-02T14:00:00.000Z&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  },</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 <p>Удаление документов методом <code>delete</code> с применением оператора <code>or</code></p>
-<pre><code class="language-js"><span class="hl-5">// delete(where)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">delete</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">or:</span><span class="hl-1"> [</span><br/><span class="hl-1">    {</span><span class="hl-4">sent:</span><span class="hl-1"> </span><span class="hl-6">false</span><span class="hl-1">},</span><br/><span class="hl-1">    {</span><span class="hl-4">title:</span><span class="hl-1"> {</span><span class="hl-4">like:</span><span class="hl-1"> </span><span class="hl-2">&#39;draft&#39;</span><span class="hl-1">}},</span><br/><span class="hl-1">  ],</span><br/><span class="hl-1">});</span>
+<pre><code class="language-js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">delete</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">or:</span><span class="hl-1"> [</span><br/><span class="hl-1">    {</span><span class="hl-4">sent:</span><span class="hl-1"> </span><span class="hl-6">false</span><span class="hl-1">},</span><br/><span class="hl-1">    {</span><span class="hl-4">title:</span><span class="hl-1"> {</span><span class="hl-4">like:</span><span class="hl-1"> </span><span class="hl-2">&#39;draft&#39;</span><span class="hl-1">}},</span><br/><span class="hl-1">  ],</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 <a id="md:order" class="tsd-anchor"></a><h3><a href="#md:order">order</a></h3><p>Параметр упорядочивает выборку по указанным свойствам документа. Обратное
 направление порядка можно задать постфиксом <code>DESC</code> в названии свойства.</p>
 <p><strong>Примеры</strong></p>
 <p>Упорядочить по свойству <code>createdAt</code></p>
-<pre><code class="language-js"><span class="hl-5">// find(filter)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">find</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">order:</span><span class="hl-1"> </span><span class="hl-2">&#39;createdAt&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
+<pre><code class="language-js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">find</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">order:</span><span class="hl-1"> </span><span class="hl-2">&#39;createdAt&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 <p>Упорядочить по свойству <code>createdAt</code> в обратном порядке.</p>
-<pre><code class="language-js"><span class="hl-5">// find(filter)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">find</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">order:</span><span class="hl-1"> </span><span class="hl-2">&#39;createdAt DESC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
+<pre><code class="language-js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">find</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">order:</span><span class="hl-1"> </span><span class="hl-2">&#39;createdAt DESC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 <p>Упорядочить по нескольким свойствам в разных направлениях.</p>
-<pre><code class="language-js"><span class="hl-5">// find(filter)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">find</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">order:</span><span class="hl-1"> [</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;title&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;price ASC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;featured DESC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  ],</span><br/><span class="hl-1">});</span>
+<pre><code class="language-js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">rep</span><span class="hl-1">.</span><span class="hl-0">find</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">order:</span><span class="hl-1"> [</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;title&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;price ASC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;featured DESC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  ],</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 <p><em>i. Направление порядка <code>ASC</code> указывать необязательно.</em></p>
 <a id="md:тесты" class="tsd-anchor"></a><h2><a href="#md:тесты">Тесты</a></h2><pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test</span>

File diff suppressed because it is too large
+ 0 - 0
docs/interfaces/AndClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/interfaces/OrClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/AnyObject.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/BelongsToDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/DEFAULT_PRIMARY_KEY_PROPERTY_NAME.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/DatasourceDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/FieldsClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/FilterClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/Flatten.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/FullPropertyDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/HasManyDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/HasOneDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/Identity.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/IncludeClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/ItemFilterClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/ModelData.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/ModelDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/ModelId.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/NestedIncludeClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/NormalizedFieldsClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/NormalizedIncludeClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/OperatorClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/OptionalUnlessRequiredId.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/OrderClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PartialBy.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PartialWithoutId.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PolyBelongsToDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PolyHasManyDefinitionWithTargetKeys.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PolyHasManyDefinitionWithTargetRelationName.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PolyHasOneDefinitionWithTargetKeys.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PolyHasOneDefinitionWithTargetRelationName.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PropertiesClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PropertyDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/PropertyDefinitionMap.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/ReferencesManyDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/RelationDefinition.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/RelationDefinitionMap.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/WhereClause.html


File diff suppressed because it is too large
+ 0 - 0
docs/types/WithoutId.html


Some files were not shown because too many files changed in this diff