typof 1.0.13 → 1.0.14

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 (4) hide show
  1. package/README.md +22 -20
  2. package/dist/main.d.mts +4 -2
  3. package/dist/main.d.ts +4 -2
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -1,7 +1,6 @@
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
- [Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
5
4
  [Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
6
5
  [Buffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
7
6
  [Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
@@ -12,6 +11,7 @@
12
11
  <!---->
13
12
 
14
13
  [Types]: ./src/types/Types.type.ts
14
+ [UnknownObject]: ./src/types/UnknownObject.type.ts
15
15
 
16
16
  <div align="center">
17
17
  <br/>
@@ -36,8 +36,8 @@
36
36
  - [Types](#types)
37
37
  - [Links](#links)
38
38
  - [Discord](https://discord.gg/keift)
39
- - [Telegram](https://t.me/keiftt)
40
- - [Twitter](https://x.com/keiftttt)
39
+ - [Telegram](https://t.me/keiftco)
40
+ - [Twitter](https://x.com/keiftco)
41
41
  - [GitHub](https://github.com/keift)
42
42
  - [License](#license)
43
43
 
@@ -93,7 +93,8 @@ typof
93
93
  ├── _null(value)
94
94
  ├── _undefined(value)
95
95
  │
96
- └── type Types
96
+ ├── type Types
97
+ └── type UnknownObject
97
98
  ```
98
99
 
99
100
  ### Import
@@ -112,7 +113,7 @@ Infer types.
112
113
 
113
114
  > | Parameter | Type | Default | Description |
114
115
  > | --------- | ------- | ------- | --------------------- |
115
- > | value | Unknown | | Value to infer types. |
116
+ > | `value` | Unknown | | Value to infer types. |
116
117
  >
117
118
  > returns [Types]\[]
118
119
  >
@@ -160,7 +161,7 @@ Convert to string.
160
161
 
161
162
  > | Parameter | Type | Default | Description |
162
163
  > | --------- | ------- | ------- | ----------------- |
163
- > | value | Unknown | | Value to convert. |
164
+ > | `value` | Unknown | | Value to convert. |
164
165
  >
165
166
  > returns [String]
166
167
  >
@@ -184,7 +185,7 @@ Convert to number.
184
185
 
185
186
  > | Parameter | Type | Default | Description |
186
187
  > | --------- | ------- | ------- | ----------------- |
187
- > | value | Unknown | | Value to convert. |
188
+ > | `value` | Unknown | | Value to convert. |
188
189
  >
189
190
  > returns [Number]
190
191
  >
@@ -204,7 +205,7 @@ Convert to integer.
204
205
 
205
206
  > | Parameter | Type | Default | Description |
206
207
  > | --------- | ------- | ------- | ----------------- |
207
- > | value | Unknown | | Value to convert. |
208
+ > | `value` | Unknown | | Value to convert. |
208
209
  >
209
210
  > returns [Number]
210
211
  >
@@ -224,7 +225,7 @@ Convert to boolean.
224
225
 
225
226
  > | Parameter | Type | Default | Description |
226
227
  > | --------- | ------- | ------- | ----------------- |
227
- > | value | Unknown | | Value to convert. |
228
+ > | `value` | Unknown | | Value to convert. |
228
229
  >
229
230
  > returns [Boolean] | Value
230
231
  >
@@ -244,7 +245,7 @@ Convert to date.
244
245
 
245
246
  > | Parameter | Type | Default | Description |
246
247
  > | --------- | ------- | ------- | ----------------- |
247
- > | value | Unknown | | Value to convert. |
248
+ > | `value` | Unknown | | Value to convert. |
248
249
  >
249
250
  > returns [Date] | Value
250
251
  >
@@ -264,9 +265,9 @@ Convert to object.
264
265
 
265
266
  > | Parameter | Type | Default | Description |
266
267
  > | --------- | ------- | ------- | ----------------- |
267
- > | value | Unknown | | Value to convert. |
268
+ > | `value` | Unknown | | Value to convert. |
268
269
  >
269
- > returns [Object] | Value
270
+ > returns [UnknownObject] | Value
270
271
  >
271
272
  > Example:
272
273
  >
@@ -283,7 +284,7 @@ Convert to array.
283
284
 
284
285
  > | Parameter | Type | Default | Description |
285
286
  > | --------- | ------- | ------- | ----------------- |
286
- > | value | Unknown | | Value to convert. |
287
+ > | `value` | Unknown | | Value to convert. |
287
288
  >
288
289
  > returns Unknown\[] | Value
289
290
  >
@@ -302,7 +303,7 @@ Convert to null.
302
303
 
303
304
  > | Parameter | Type | Default | Description |
304
305
  > | --------- | ------- | ------- | ----------------- |
305
- > | value | Unknown | | Value to convert. |
306
+ > | `value` | Unknown | | Value to convert. |
306
307
  >
307
308
  > returns [Null] | Value
308
309
  >
@@ -322,7 +323,7 @@ Convert to undefined.
322
323
 
323
324
  > | Parameter | Type | Default | Description |
324
325
  > | --------- | ------- | ------- | ----------------- |
325
- > | value | Unknown | | Value to convert. |
326
+ > | `value` | Unknown | | Value to convert. |
326
327
  >
327
328
  > returns [Undefined] | Value
328
329
  >
@@ -336,15 +337,16 @@ Convert to undefined.
336
337
 
337
338
  ### Types
338
339
 
339
- | Type |
340
- | ------- |
341
- | [Types] |
340
+ | Type |
341
+ | --------------- |
342
+ | [Types] |
343
+ | [UnknownObject] |
342
344
 
343
345
  ## Links
344
346
 
345
347
  - [Discord](https://discord.gg/keift)
346
- - [Telegram](https://t.me/keiftt)
347
- - [Twitter](https://x.com/keiftttt)
348
+ - [Telegram](https://t.me/keiftco)
349
+ - [Twitter](https://x.com/keiftco)
348
350
  - [GitHub](https://github.com/keift)
349
351
 
350
352
  ## License
package/dist/main.d.mts CHANGED
@@ -1,14 +1,16 @@
1
1
  type Types = 'string' | 'number' | 'integer' | 'float' | 'boolean' | 'date' | 'object' | 'array' | 'null' | 'undefined';
2
2
 
3
+ type UnknownObject = Record<string, unknown>;
4
+
3
5
  declare const typof: (value: unknown) => Types[];
4
6
  declare const string: (value: unknown) => string;
5
7
  declare const number: (value: unknown) => number;
6
8
  declare const integer: (value: unknown) => number;
7
9
  declare const boolean: <Value>(value: Value) => boolean | Value;
8
10
  declare const date: <Value>(value: Value) => Date | Value;
9
- declare const object: <Value>(value: Value) => object | Value;
11
+ declare const object: <Value>(value: Value) => UnknownObject | Value;
10
12
  declare const array: <Value>(value: Value) => unknown[] | Value;
11
13
  declare const _null: <Value>(value: Value) => null | Value;
12
14
  declare const _undefined: <Value>(value: Value) => undefined | Value;
13
15
 
14
- export { type Types, _null, _undefined, array, boolean, date, integer, number, object, string, typof };
16
+ export { type Types, type UnknownObject, _null, _undefined, array, boolean, date, integer, number, object, string, typof };
package/dist/main.d.ts CHANGED
@@ -1,14 +1,16 @@
1
1
  type Types = 'string' | 'number' | 'integer' | 'float' | 'boolean' | 'date' | 'object' | 'array' | 'null' | 'undefined';
2
2
 
3
+ type UnknownObject = Record<string, unknown>;
4
+
3
5
  declare const typof: (value: unknown) => Types[];
4
6
  declare const string: (value: unknown) => string;
5
7
  declare const number: (value: unknown) => number;
6
8
  declare const integer: (value: unknown) => number;
7
9
  declare const boolean: <Value>(value: Value) => boolean | Value;
8
10
  declare const date: <Value>(value: Value) => Date | Value;
9
- declare const object: <Value>(value: Value) => object | Value;
11
+ declare const object: <Value>(value: Value) => UnknownObject | Value;
10
12
  declare const array: <Value>(value: Value) => unknown[] | Value;
11
13
  declare const _null: <Value>(value: Value) => null | Value;
12
14
  declare const _undefined: <Value>(value: Value) => undefined | Value;
13
15
 
14
- export { type Types, _null, _undefined, array, boolean, date, integer, number, object, string, typof };
16
+ export { type Types, type UnknownObject, _null, _undefined, array, boolean, date, integer, number, object, string, typof };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "typof",
3
- "version": "1.0.13",
3
+ "version": "1.0.14",
4
4
  "description": "Infer types.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/keift/typof",