yuppi 1.3.11 → 1.3.13

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 (2) hide show
  1. package/README.md +29 -25
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,13 +1,16 @@
1
1
  [String]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
2
2
  [Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number
3
3
  [Boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
4
- [Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
5
4
  [Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
6
- [Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
5
+ [Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
7
6
  [Buffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
8
- [Function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function
9
7
  [Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
10
8
  [Void]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined
9
+ [Null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/null
10
+ [Undefined]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined
11
+
12
+ <!---->
13
+
11
14
  [Domain]: ./src/patterns/Domain.pattern.ts
12
15
  [Email]: ./src/patterns/Email.pattern.ts
13
16
  [HTTP]: ./src/patterns/HTTP.pattern.ts
@@ -72,19 +75,19 @@ Schemas that can be converted to Yup and JSON Schema.
72
75
  You can install it as follows.
73
76
 
74
77
  ```shell
75
- // NPM
78
+ # NPM
76
79
  npm add yuppi
77
80
 
78
- // PNPM
81
+ # PNPM
79
82
  pnpm add yuppi
80
83
 
81
- // Yarn
84
+ # Yarn
82
85
  yarn add yuppi
83
86
 
84
- // Bun
87
+ # Bun
85
88
  bun add yuppi
86
89
 
87
- // Deno
90
+ # Deno
88
91
  deno add yuppi
89
92
  ```
90
93
 
@@ -105,6 +108,7 @@ Yuppi
105
108
  │ └── convertToJSONSchema(schema)
106
109
  │
107
110
  ├── Patterns
111
+ │ │
108
112
  │ ├── Domain
109
113
  │ ├── Email
110
114
  │ ├── HTTP
@@ -134,9 +138,9 @@ import { Yuppi, Patterns } from 'yuppi';
134
138
 
135
139
  Yuppi schema builder.
136
140
 
137
- > | Parameter | Default | Description |
138
- > | --------- | --------------------- | ---------------------------------------------------- |
139
- > | options | [YuppiOptionsDefault] | [YuppiOptions] (optional)<br/>Constructor's options. |
141
+ > | Parameter | Type | Default | Description |
142
+ > | --------- | -------------- | --------------------- | ---------------------- |
143
+ > | options? | [YuppiOptions] | [YuppiOptionsDefault] | Constructor's options. |
140
144
  >
141
145
  > Example:
142
146
  >
@@ -150,10 +154,10 @@ Yuppi schema builder.
150
154
 
151
155
  Validate the properties with your Yuppi schema.
152
156
 
153
- > | Parameter | Default | Description |
154
- > | ---------- | ------- | ------------------------------------------ |
155
- > | schema | | [Schema]<br/>Yuppi schema. |
156
- > | properties | | [AnyObject]<br/>Properties to be validate. |
157
+ > | Parameter | Type | Default | Description |
158
+ > | ---------- | ----------- | ------- | -------------------------- |
159
+ > | schema | [Schema] | | Yuppi schema. |
160
+ > | properties | [AnyObject] | | Properties to be validate. |
157
161
  >
158
162
  > returns [AnyObject]
159
163
  >
@@ -214,10 +218,10 @@ Validate the properties with your Yuppi schema.
214
218
 
215
219
  Declare your Yuppi schema for TypeScript.
216
220
 
217
- > | Parameter | Default | Description |
218
- > | --------- | ------- | ------------------------------ |
219
- > | schema | | [Schema]<br/>Yuppi schema. |
220
- > | name | | [String]<br/>Declaration name. |
221
+ > | Parameter | Type | Default | Description |
222
+ > | --------- | -------- | ------- | ----------------- |
223
+ > | schema | [Schema] | | Yuppi schema. |
224
+ > | name | [String] | | Declaration name. |
221
225
  >
222
226
  > returns [Void]
223
227
  >
@@ -244,9 +248,9 @@ Declare your Yuppi schema for TypeScript.
244
248
 
245
249
  Convert your Yuppi schema into Yup schema.
246
250
 
247
- > | Parameter | Default | Description |
248
- > | --------- | ------- | -------------------------- |
249
- > | schema | | [Schema]<br/>Yuppi schema. |
251
+ > | Parameter | Type | Default | Description |
252
+ > | --------- | -------- | ------- | ------------- |
253
+ > | schema | [Schema] | | Yuppi schema. |
250
254
  >
251
255
  > returns [AnyObject]
252
256
  >
@@ -262,9 +266,9 @@ Convert your Yuppi schema into Yup schema.
262
266
 
263
267
  Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
264
268
 
265
- > | Parameter | Default | Description |
266
- > | --------- | ------- | -------------------------- |
267
- > | schema | | [Schema]<br/>Yuppi schema. |
269
+ > | Parameter | Type | Default | Description |
270
+ > | --------- | -------- | ------- | ------------- |
271
+ > | schema | [Schema] | | Yuppi schema. |
268
272
  >
269
273
  > returns [JSONSchema]
270
274
  >
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yuppi",
3
- "version": "1.3.11",
3
+ "version": "1.3.13",
4
4
  "description": "Schemas that can be converted to Yup and JSON Schema.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/keift/yuppi",