Skip to content

Commit

Permalink
Use Fast Guard For Compositing
Browse files Browse the repository at this point in the history
  • Loading branch information
sinclairzx81 committed Apr 25, 2024
1 parent 976ffa5 commit 85891e3
Show file tree
Hide file tree
Showing 31 changed files with 324 additions and 48 deletions.
20 changes: 12 additions & 8 deletions example/index.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
import { Type } from '@sinclair/typebox'
import { Type, TypeGuard } from '@sinclair/typebox'
import { Value } from '@sinclair/typebox/value'

const T = Type.Object({
x: Type.Number(),
y: Type.Number(),
z: Type.Number(),
})
const K = Type.TemplateLiteral('prop${0|1}${0|1}${0|1}${0|1}${0|1}${0|1}')
const T = Type.Mapped(K, (_) =>
Type.Object({
x: Type.Number(),
y: Type.Number(),
z: Type.Number(),
}),
)

const S = Date.now()
for (let i = 0; i < 1; i++) {
console.log('-----------------------------------')
for (let i = 0; i < 1000; i++) {
Type.Composite([T, T, T])
}
console.dir(Type.Composite([T, T, T]), { depth: 100 })
console.log(Date.now() - S)

2 changes: 1 addition & 1 deletion src/type/awaited/awaited.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import { CloneType } from '../clone/type'
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsIntersect, IsUnion, IsPromise } from '../guard/type'
import { IsIntersect, IsUnion, IsPromise } from '../guard/kind'
// ------------------------------------------------------------------
// FromRest
// ------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/type/composite/composite.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import { SetDistinct, TSetDistinct } from '../sets/index'
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsNever } from '../guard/type'
import { IsNever } from '../guard/kind'
// ------------------------------------------------------------------
// CompositeKeys
// ------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/type/deref/deref.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import { IsUndefined } from '../guard/value'
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsConstructor, IsFunction, IsIntersect, IsUnion, IsTuple, IsArray, IsObject, IsPromise, IsAsyncIterator, IsIterator, IsRef } from '../guard/type'
import { IsConstructor, IsFunction, IsIntersect, IsUnion, IsTuple, IsArray, IsObject, IsPromise, IsAsyncIterator, IsIterator, IsRef } from '../guard/kind'
// ------------------------------------------------------------------
// FromRest
// ------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/type/exclude/exclude.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import { ExcludeFromTemplateLiteral, type TExcludeFromTemplateLiteral } from './
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsMappedResult, IsTemplateLiteral, IsUnion } from '../guard/type'
import { IsMappedResult, IsTemplateLiteral, IsUnion } from '../guard/kind'
// ------------------------------------------------------------------
// ExcludeRest
// ------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/type/extends/extends.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import { ExtendsFromMappedResult, type TExtendsFromMappedResult } from './extend
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsMappedKey, IsMappedResult } from '../guard/type'
import { IsMappedKey, IsMappedResult } from '../guard/kind'

// prettier-ignore
type TExtendsResolve<L extends TSchema, R extends TSchema, T extends TSchema, U extends TSchema> = (
Expand Down
2 changes: 1 addition & 1 deletion src/type/extract/extract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import { ExtractFromTemplateLiteral, type TExtractFromTemplateLiteral } from './
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsMappedResult, IsTemplateLiteral, IsUnion } from '../guard/type'
import { IsMappedResult, IsTemplateLiteral, IsUnion } from '../guard/kind'

// ------------------------------------------------------------------
// ExtractRest
Expand Down
1 change: 1 addition & 0 deletions src/type/guard/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ THE SOFTWARE.
---------------------------------------------------------------------------*/

export * as KindGuard from './kind'
export * as TypeGuard from './type'
export * as ValueGuard from './value'
281 changes: 281 additions & 0 deletions src/type/guard/kind.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
/*--------------------------------------------------------------------------
@sinclair/typebox/type
The MIT License (MIT)
Copyright (c) 2017-2024 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
---------------------------------------------------------------------------*/

import * as ValueGuard from './value'
import { Kind, TransformKind, ReadonlyKind, OptionalKind } from '../symbols/index'
import { TransformOptions } from '../transform/index'
import { TTemplateLiteral } from '../template-literal/index'
import { TArray } from '../array/index'
import { TBoolean } from '../boolean/index'
import type { TRecord } from '../record/index'
import type { TString } from '../string/index'
import type { TUnion } from '../union/index'
import type { TAny } from '../any/index'
import type { TAsyncIterator } from '../async-iterator/index'
import type { TBigInt } from '../bigint/index'
import type { TConstructor } from '../constructor/index'
import type { TFunction } from '../function/index'
import type { TInteger } from '../integer/index'
import type { TIntersect } from '../intersect/index'
import type { TIterator } from '../iterator/index'
import type { TLiteral } from '../literal/index'
import type { TMappedKey, TMappedResult } from '../mapped/index'
import type { TNever } from '../never/index'
import type { TNot } from '../not/index'
import type { TNull } from '../null/index'
import type { TNumber } from '../number/index'
import type { TObject, TProperties } from '../object/index'
import type { TOptional } from '../optional/index'
import type { TPromise } from '../promise/index'
import type { TReadonly } from '../readonly/index'
import type { TRef } from '../ref/index'
import type { TRegExp } from '../regexp/index'
import type { TSchema } from '../schema/index'
import type { TSymbol } from '../symbol/index'
import type { TTuple } from '../tuple/index'
import type { TUint8Array } from '../uint8array/index'
import type { TUndefined } from '../undefined/index'
import type { TUnknown } from '../unknown/index'
import type { TUnsafe } from '../unsafe/index'
import type { TVoid } from '../void/index'
import type { TDate } from '../date/index'
import type { TThis } from '../recursive/index'

/** `[Unsafe]` Returns true if this value has a Readonly symbol */
export function IsReadonly<T extends TSchema>(value: T): value is TReadonly<T> {
return ValueGuard.IsObject(value) && value[ReadonlyKind] === 'Readonly'
}
/** `[Unsafe]` Returns true if this value has a Optional symbol */
export function IsOptional<T extends TSchema>(value: T): value is TOptional<T> {
return ValueGuard.IsObject(value) && value[OptionalKind] === 'Optional'
}
/** `[Unsafe]` Returns true if the given value is TAny */
export function IsAny(value: unknown): value is TAny {
return IsKindOf(value, 'Any')
}
/** `[Unsafe]` Returns true if the given value is TArray */
export function IsArray(value: unknown): value is TArray {
return IsKindOf(value, 'Array')
}
/** `[Unsafe]` Returns true if the given value is TAsyncIterator */
export function IsAsyncIterator(value: unknown): value is TAsyncIterator {
return IsKindOf(value, 'AsyncIterator')
}
/** `[Unsafe]` Returns true if the given value is TBigInt */
export function IsBigInt(value: unknown): value is TBigInt {
return IsKindOf(value, 'BigInt')
}
/** `[Unsafe]` Returns true if the given value is TBoolean */
export function IsBoolean(value: unknown): value is TBoolean {
return IsKindOf(value, 'Boolean')
}
/** `[Unsafe]` Returns true if the given value is TConstructor */
export function IsConstructor(value: unknown): value is TConstructor {
return IsKindOf(value, 'Constructor')
}
/** `[Unsafe]` Returns true if the given value is TDate */
export function IsDate(value: unknown): value is TDate {
return IsKindOf(value, 'Date')
}
/** `[Unsafe]` Returns true if the given value is TFunction */
export function IsFunction(value: unknown): value is TFunction {
return IsKindOf(value, 'Function')
}
/** `[Unsafe]` Returns true if the given value is TInteger */
export function IsInteger(value: unknown): value is TInteger {
return IsKindOf(value, 'Integer')
}
/** `[Unsafe]` Returns true if the given schema is TProperties */
export function IsProperties(value: unknown): value is TProperties {
return ValueGuard.IsObject(value)
}
/** `[Unsafe]` Returns true if the given value is TIntersect */
export function IsIntersect(value: unknown): value is TIntersect {
return IsKindOf(value, 'Intersect')
}
/** `[Unsafe]` Returns true if the given value is TIterator */
export function IsIterator(value: unknown): value is TIterator {
return IsKindOf(value, 'Iterator')
}
/** `[Unsafe]` Returns true if the given value is a TKind with the given name. */
export function IsKindOf<T extends string>(value: unknown, kind: T): value is Record<PropertyKey, unknown> & { [Kind]: T } {
return ValueGuard.IsObject(value) && Kind in value && value[Kind] === kind
}
/** `[Unsafe]` Returns true if the given value is TLiteral<string> */
export function IsLiteralString(value: unknown): value is TLiteral<string> {
return IsLiteral(value) && ValueGuard.IsString(value.const)
}
/** `[Unsafe]` Returns true if the given value is TLiteral<number> */
export function IsLiteralNumber(value: unknown): value is TLiteral<number> {
return IsLiteral(value) && ValueGuard.IsNumber(value.const)
}
/** `[Unsafe]` Returns true if the given value is TLiteral<boolean> */
export function IsLiteralBoolean(value: unknown): value is TLiteral<boolean> {
return IsLiteral(value) && ValueGuard.IsBoolean(value.const)
}
/** `[Unsafe]` Returns true if the given value is TLiteral */
export function IsLiteral(value: unknown): value is TLiteral {
return IsKindOf(value, 'Literal')
}
/** `[Unsafe]` Returns true if the given value is a TMappedKey */
export function IsMappedKey(value: unknown): value is TMappedKey {
return IsKindOf(value, 'MappedKey')
}
/** `[Unsafe]` Returns true if the given value is TMappedResult */
export function IsMappedResult(value: unknown): value is TMappedResult {
return IsKindOf(value, 'MappedResult')
}
/** `[Unsafe]` Returns true if the given value is TNever */
export function IsNever(value: unknown): value is TNever {
return IsKindOf(value, 'Never')
}
/** `[Unsafe]` Returns true if the given value is TNot */
export function IsNot(value: unknown): value is TNot {
return IsKindOf(value, 'Not')
}
/** `[Unsafe]` Returns true if the given value is TNull */
export function IsNull(value: unknown): value is TNull {
return IsKindOf(value, 'Null')
}
/** `[Unsafe]` Returns true if the given value is TNumber */
export function IsNumber(value: unknown): value is TNumber {
return IsKindOf(value, 'Number')
}
/** `[Unsafe]` Returns true if the given value is TObject */
export function IsObject(value: unknown): value is TObject {
return IsKindOf(value, 'Object')
}
/** `[Unsafe]` Returns true if the given value is TPromise */
export function IsPromise(value: unknown): value is TPromise {
return IsKindOf(value, 'Promise')
}
/** `[Unsafe]` Returns true if the given value is TRecord */
export function IsRecord(value: unknown): value is TRecord {
return IsKindOf(value, 'Record')
}
/** `[Unsafe]` Returns true if the given value is TRef */
export function IsRef(value: unknown): value is TRef {
return IsKindOf(value, 'Ref')
}
/** `[Unsafe]` Returns true if the given value is TRegExp */
export function IsRegExp(value: unknown): value is TRegExp {
return IsKindOf(value, 'RegExp')
}
/** `[Unsafe]` Returns true if the given value is TString */
export function IsString(value: unknown): value is TString {
return IsKindOf(value, 'String')
}
/** `[Unsafe]` Returns true if the given value is TSymbol */
export function IsSymbol(value: unknown): value is TSymbol {
return IsKindOf(value, 'Symbol')
}
/** `[Unsafe]` Returns true if the given value is TTemplateLiteral */
export function IsTemplateLiteral(value: unknown): value is TTemplateLiteral {
return IsKindOf(value, 'TemplateLiteral')
}
/** `[Unsafe]` Returns true if the given value is TThis */
export function IsThis(value: unknown): value is TThis {
return IsKindOf(value, 'This')
}
/** `[Unsafe]` Returns true of this value is TTransform */
export function IsTransform(value: unknown): value is { [TransformKind]: TransformOptions } {
return ValueGuard.IsObject(value) && TransformKind in value
}
/** `[Unsafe]` Returns true if the given value is TTuple */
export function IsTuple(value: unknown): value is TTuple {
return IsKindOf(value, 'Tuple')
}
/** `[Unsafe]` Returns true if the given value is TUndefined */
export function IsUndefined(value: unknown): value is TUndefined {
return IsKindOf(value, 'Undefined')
}
/** `[Unsafe]` Returns true if the given value is TUnion */
export function IsUnion(value: unknown): value is TUnion {
return IsKindOf(value, 'Union')
}
/** `[Unsafe]` Returns true if the given value is TUint8Array */
export function IsUint8Array(value: unknown): value is TUint8Array {
return IsKindOf(value, 'Uint8Array')
}
/** `[Unsafe]` Returns true if the given value is TUnknown */
export function IsUnknown(value: unknown): value is TUnknown {
return IsKindOf(value, 'Unknown')
}
/** `[Unsafe]` Returns true if the given value is a raw TUnsafe */
export function IsUnsafe(value: unknown): value is TUnsafe<unknown> {
return IsKindOf(value, 'Unsafe')
}
/** `[Unsafe]` Returns true if the given value is TVoid */
export function IsVoid(value: unknown): value is TVoid {
return IsKindOf(value, 'Void')
}
/** `[Unsafe]` Returns true if the given value is TKind */
export function IsKind(value: unknown): value is Record<PropertyKey, unknown> & { [Kind]: string } {
return ValueGuard.IsObject(value) && Kind in value && ValueGuard.IsString(value[Kind])
}
/** `[Unsafe]` Returns true if the given value is TSchema */
export function IsSchema(value: unknown): value is TSchema {
// prettier-ignore
return (
IsAny(value) ||
IsArray(value) ||
IsBoolean(value) ||
IsBigInt(value) ||
IsAsyncIterator(value) ||
IsConstructor(value) ||
IsDate(value) ||
IsFunction(value) ||
IsInteger(value) ||
IsIntersect(value) ||
IsIterator(value) ||
IsLiteral(value) ||
IsMappedKey(value) ||
IsMappedResult(value) ||
IsNever(value) ||
IsNot(value) ||
IsNull(value) ||
IsNumber(value) ||
IsObject(value) ||
IsPromise(value) ||
IsRecord(value) ||
IsRef(value) ||
IsRegExp(value) ||
IsString(value) ||
IsSymbol(value) ||
IsTemplateLiteral(value) ||
IsThis(value) ||
IsTuple(value) ||
IsUndefined(value) ||
IsUnion(value) ||
IsUint8Array(value) ||
IsUnknown(value) ||
IsUnsafe(value) ||
IsVoid(value) ||
IsKind(value)
)
}
2 changes: 1 addition & 1 deletion src/type/guard/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ export function IsSymbol(value: unknown): value is TSymbol {
)
}
/** Returns true if the given value is TTemplateLiteral */
export function IsTemplateLiteral(value: unknown): value is TTemplateLiteral<TTemplateLiteralKind[]> {
export function IsTemplateLiteral(value: unknown): value is TTemplateLiteral {
// prettier-ignore
return (
IsKindOf(value, 'TemplateLiteral') &&
Expand Down
2 changes: 1 addition & 1 deletion src/type/indexed/indexed-property-keys.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import type { TUnion } from '../union/index'
// ------------------------------------------------------------------
// TypeGuard
// ------------------------------------------------------------------
import { IsTemplateLiteral, IsUnion, IsLiteral, IsNumber, IsInteger } from '../guard/type'
import { IsTemplateLiteral, IsUnion, IsLiteral, IsNumber, IsInteger } from '../guard/kind'
// ------------------------------------------------------------------
// FromTemplateLiteral
// ------------------------------------------------------------------
Expand Down

0 comments on commit 85891e3

Please sign in to comment.