typebox 1.1.30 → 1.1.31

package/build/type/action/awaited.d.mts

@@ -7,5 +7,9 @@ export type TAwaitedDeferred<Type extends TSchema> = (TDeferred<'Awaited', [Type
 export declare function AwaitedDeferred<Type extends TSchema>(type: Type, options?: TSchemaOptions): TAwaitedDeferred<Type>;
 /** Applies an Awaited action to a type. */
 export type TAwaited<Type extends TSchema> = (TAwaitedAction<Type>);
-/** Applies an Awaited action to a type. */
+/**
+ * Applies an Awaited action to a type.
+ *
+ * @deprecated This action is being removed in the next version of TypeBox.
+ */
 export declare function Awaited<Type extends TSchema>(type: Type, options?: TSchemaOptions): TAwaited<Type>;

package/build/type/action/awaited.mjs

@@ -5,7 +5,11 @@ import { AwaitedAction } from '../engine/awaited/instantiate.mjs';
 export function AwaitedDeferred(type, options = {}) {
     return Deferred('Awaited', [type], options);
 }
-/** Applies an Awaited action to a type. */
+/**
+ * Applies an Awaited action to a type.
+ *
+ * @deprecated This action is being removed in the next version of TypeBox.
+ */
 export function Awaited(type, options = {}) {
     return AwaitedAction(type, options);
 }

package/build/type/types/async-iterator.d.mts

@@ -8,7 +8,11 @@ export interface TAsyncIterator<Type extends TSchema = TSchema> extends TSchema
     type: 'asyncIterator';
     iteratorItems: Type;
 }
-/** Creates a AsyncIterator type. */
+/**
+ * Creates a AsyncIterator type.
+ *
+ * @deprecated This type is being removed in the next version of TypeBox. A fallback will be provided under examples.
+ */
 export declare function AsyncIterator<Type extends TSchema>(iteratorItems: Type, options?: TSchemaOptions): TAsyncIterator<Type>;
 /** Returns true if the given value is a TAsyncIterator */
 export declare function IsAsyncIterator(value: unknown): value is TAsyncIterator;

package/build/type/types/async-iterator.mjs

@@ -4,7 +4,11 @@ import { IsKind } from './schema.mjs';
 // ------------------------------------------------------------------
 // Factory
 // ------------------------------------------------------------------
-/** Creates a AsyncIterator type. */
+/**
+ * Creates a AsyncIterator type.
+ *
+ * @deprecated This type is being removed in the next version of TypeBox. A fallback will be provided under examples.
+ */
 export function AsyncIterator(iteratorItems, options) {
     return Memory.Create({ '~kind': 'AsyncIterator' }, { type: 'asyncIterator', iteratorItems }, options);
 }

package/build/type/types/iterator.d.mts

@@ -8,7 +8,11 @@ export interface TIterator<Type extends TSchema = TSchema> extends TSchema {
     type: 'iterator';
     iteratorItems: Type;
 }
-/** Creates a Iterator type. */
+/**
+ * Creates a Iterator type.
+ *
+ * @deprecated This type is being removed in the next version of TypeBox. A fallback will be provided under examples.
+ */
 export declare function Iterator<Type extends TSchema>(iteratorItems: Type, options?: TSchemaOptions): TIterator<Type>;
 /** Returns true if the given value is TIterator. */
 export declare function IsIterator(value: unknown): value is TIterator;

package/build/type/types/iterator.mjs

@@ -4,7 +4,11 @@ import { IsKind } from './schema.mjs';
 // ------------------------------------------------------------------
 // Factory
 // ------------------------------------------------------------------
-/** Creates a Iterator type. */
+/**
+ * Creates a Iterator type.
+ *
+ * @deprecated This type is being removed in the next version of TypeBox. A fallback will be provided under examples.
+ */
 export function Iterator(iteratorItems, options) {
     return Memory.Create({ '~kind': 'Iterator' }, { type: 'iterator', iteratorItems }, options);
 }

package/build/type/types/promise.d.mts

@@ -8,7 +8,11 @@ export interface TPromise<Type extends TSchema = TSchema> extends TSchema {
     type: 'promise';
     item: Type;
 }
-/** Creates a Promise type. */
+/**
+ * Creates a Promise type.
+ *
+ * @deprecated This type is being removed in the next version of TypeBox. A fallback will be provided under examples.
+ */
 export declare function _Promise_<Type extends TSchema>(item: Type, options?: TSchemaOptions): TPromise<Type>;
 export { _Promise_ as Promise };
 /** Returns true if the given type is TPromise. */

package/build/type/types/promise.mjs

@@ -4,7 +4,11 @@ import { IsKind } from './schema.mjs';
 // ------------------------------------------------------------------
 // Factory
 // ------------------------------------------------------------------
-/** Creates a Promise type. */
+/**
+ * Creates a Promise type.
+ *
+ * @deprecated This type is being removed in the next version of TypeBox. A fallback will be provided under examples.
+ */
 export function _Promise_(item, options) {
     return Memory.Create({ ['~kind']: 'Promise' }, { type: 'promise', item }, options);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typebox",
   "description": "Json Schema Type Builder with Static Type Resolution for TypeScript",
-  "version": "1.1.30",
+  "version": "1.1.31",
   "keywords": [
     "typescript",
     "jsonschema"

package/readme.md

@@ -80,7 +80,6 @@ The following creates a User type and infers with Static.
 ```typescript
 import Type from 'typebox'
 
-
 // Type
 
 const User = Type.Object({                       // const User = {
@@ -100,7 +99,6 @@ const User = Type.Object({                       // const User = {
                                                  //   ]
                                                  // }
 
-
 // Static
 
 type User = Type.Static<typeof User>              // type User = {
@@ -124,7 +122,6 @@ The following uses the Script function to parse TypeScript interfaces into JSON
 ```typescript
 import Type from 'typebox'
 
-
 // Script
 
 const { User, UserUpdate } = Type.Script(`
@@ -145,7 +142,6 @@ const { User, UserUpdate } = Type.Script(`
 
 `)
 
-
 // Reflect
 
 console.log(User)                                // {
@@ -172,7 +168,6 @@ console.log(UserUpdate)                          // {
                                                  //   required: ['id']
                                                  // }
 
-
 // Static
 
 type User = Type.Static<typeof User>              // type User = {
@@ -205,7 +200,6 @@ The following uses the Schema submodule to compile a TypeBox type.
 ```typescript
 import Schema from 'typebox/schema'
 
-
 // Compile
 
 const User = Schema.Compile(Type.Object({        // const User = Validator<Type.TObject<{
@@ -214,7 +208,6 @@ const User = Schema.Compile(Type.Object({        // const User = Validator<Type.
   email: Type.String({ format: 'email' })        //   email: Type.TString;
 }))                                              // }>, { ... }>
 
-
 // Parse
 
 const user = User.Parse({                        // const user: {