Version 1.1.31 (#1585)

* Deprecation Notice for Awaited, Promise, Iterator and AsyncIterator

* ChangeLog

* Version

Author: sinclairzx81

changelog/1.1.0.md

@@ -3,6 +3,8 @@
 ---
 
 ### Version Updates
+- [Revision 1.1.31](https://github.com/sinclairzx81/typebox/pull/1585)
+  - Flag Awaited, Promise, Iterator and AsyncIterator for Deprecation
 - [Revision 1.1.30](https://github.com/sinclairzx81/typebox/pull/1584)
   - Support Recursive Indexed This
 - [Revision 1.1.29](https://github.com/sinclairzx81/typebox/pull/1583)

src/type/action/awaited.ts

@@ -50,7 +50,11 @@ export function AwaitedDeferred<Type extends TSchema>(type: Type, options: TSche
 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 function Awaited<Type extends TSchema>(type: Type, options: TSchemaOptions = {}): TAwaited<Type> {
   return AwaitedAction(type, options)
 }

src/type/types/async-iterator.ts

@@ -51,7 +51,11 @@ export interface TAsyncIterator<Type extends TSchema = TSchema> extends TSchema
 // ------------------------------------------------------------------
 // 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<Type extends TSchema>(iteratorItems: Type, options?: TSchemaOptions): TAsyncIterator<Type> {
   return Memory.Create({ '~kind': 'AsyncIterator' }, { type: 'asyncIterator', iteratorItems }, options) as never
 }

src/type/types/iterator.ts

@@ -51,7 +51,11 @@ export interface TIterator<Type extends TSchema = TSchema> extends TSchema {
 // ------------------------------------------------------------------
 // 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<Type extends TSchema>(iteratorItems: Type, options?: TSchemaOptions): TIterator<Type> {
   return Memory.Create({ '~kind': 'Iterator' }, { type: 'iterator', iteratorItems }, options) as never
 }

src/type/types/promise.ts

@@ -51,7 +51,11 @@ export interface TPromise<Type extends TSchema = TSchema> extends TSchema {
 // ------------------------------------------------------------------
 // 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_<Type extends TSchema>(item: Type, options?: TSchemaOptions): TPromise<Type> {
   return Memory.Create({ ['~kind']: 'Promise' }, { type: 'promise', item }, options) as never
 }

tasks.ts

@@ -9,7 +9,7 @@ import { Metrics } from './task/metrics/index.ts'
 import { Spec } from './task/spec/index.ts'
 import { Task } from 'tasksmith'
 
-const Version = '1.1.30'
+const Version = '1.1.31'
 
 // ------------------------------------------------------------------
 // Build