tsc-ts 0.0.4 → 0.0.5

package/dist/api/compiler/checker-type-operators.d.ts

@@ -0,0 +1,109 @@
+import { type Node } from './ast.js';
+import { type Symbol } from './symbol.js';
+import type { Checker } from './checker.js';
+import { AccessFlags, ConditionalRoot, ConditionalType, IndexFlags, IndexedAccessType, type MappedType, type TemplateLiteralType, type Type, type TypeAlias, TypeFlags, type TypeMapper, type TypeParameter, type TupleType, type UnionType } from './checker-types.js';
+export declare function isGenericType(c: Checker, t: Type): boolean;
+export declare function isGenericObjectType(c: Checker, t: Type): boolean;
+export declare function isGenericIndexType(c: Checker, t: Type): boolean;
+export declare function isGenericMappedType(c: Checker, t: Type): boolean;
+/** Unions reducible on instantiation stay generic so the reduction flows through. */
+export declare function isGenericReducibleType(c: Checker, t: Type): boolean;
+export declare function getIndexType(c: Checker, t: Type): Type;
+export declare function getIndexTypeEx(c: Checker, t: Type, indexFlags: IndexFlags): Type;
+export declare function shouldDeferIndexType(c: Checker, t: Type, indexFlags: IndexFlags): boolean;
+export declare function getLiteralTypeFromProperties(c: Checker, t: Type, include: TypeFlags, includeOrigin: boolean): Type;
+export declare function getLiteralTypeFromProperty(c: Checker, prop: Symbol, include: TypeFlags, includeNonPublic: boolean): Type;
+export declare function getLiteralTypeFromPropertyName(c: Checker, name: Node): Type | undefined;
+/** The keys of a mapped type, without resolving its properties. */
+export declare function getIndexForMappedType(c: Checker, t: MappedType, indexFlags?: IndexFlags): Type;
+export declare function forEachType(t: Type, f: (t: Type) => void): void;
+/** The keys a generic mapped type with an `as` clause maps the apparent keys of its modifiers type to. */
+export declare function getApparentMappedTypeKeys(c: Checker, nameType: Type, targetType: MappedType): Type;
+export declare function getIndexedAccessType(c: Checker, objectType: Type, indexType: Type): Type;
+export declare function getIndexedAccessTypeEx(c: Checker, objectType: Type, indexType: Type, accessFlags: AccessFlags, accessNode: Node | undefined, alias: TypeAlias | undefined): Type;
+export declare function getIndexedAccessTypeOrUndefined(c: Checker, objectType: Type, indexType: Type, accessFlags: AccessFlags): Type | undefined;
+export declare function getIndexedAccessTypeOrUndefinedEx(c: Checker, objectType: Type, indexType: Type, accessFlags: AccessFlags, accessNode: Node | undefined, alias: TypeAlias | undefined): Type | undefined;
+export declare function isStringIndexSignatureOnlyType(c: Checker, t: Type): boolean;
+export declare function isTypeAssignableToKind(c: Checker, source: Type, kind: TypeFlags): boolean;
+export declare function isTypeAssignableToKindEx(c: Checker, source: Type, kind: TypeFlags, strict: boolean): boolean;
+export declare function getPropertyNameFromIndex(indexType: Type): string | undefined;
+export declare function getTupleElementTypeOutOfStartCount(c: Checker, t: Type, index: number, undefinedLikeType: Type | undefined): Type;
+export declare function getRestTypeOfTupleType(c: Checker, t: Type): Type | undefined;
+export declare function getElementTypeOfSliceOfTupleType(c: Checker, t: Type, index: number, endSkipCount: number, writing: boolean, noReductions: boolean): Type | undefined;
+export declare function getConstraintOfIndexedAccess(c: Checker, t: IndexedAccessType): Type | undefined;
+export declare function isMappedTypeGenericIndexedAccess(c: Checker, t: Type): boolean;
+/** For `{ [P in K]: E }[X]`, E with P replaced by X. */
+export declare function substituteIndexedMappedType(c: Checker, objectType: MappedType, index: Type): Type;
+/** The optionality modifiers of a mapped type or its modifiers type, or of all the types of an intersection. */
+export declare function getCombinedMappedTypeOptionality(c: Checker, t: Type): number;
+export declare function getSimplifiedType(c: Checker, t: Type, writing: boolean): Type;
+export declare function isNoInferType(c: Checker, t: Type): boolean;
+export declare function getNoInferType(c: Checker, t: Type): Type;
+export declare function getSubstitutionType(c: Checker, baseType: Type, constraint: Type): Type;
+export declare function getSubstitutionIntersection(c: Checker, t: Type): Type;
+export declare const enum IntrinsicTypeKind {
+    Unknown = 0,
+    Uppercase = 1,
+    Lowercase = 2,
+    Capitalize = 3,
+    Uncapitalize = 4,
+    NoInfer = 5
+}
+export declare function intrinsicTypeKind(name: string): IntrinsicTypeKind;
+export declare function applyStringMapping(symbol: Symbol, s: string): string;
+export declare function getStringMappingType(c: Checker, symbol: Symbol, t: Type): Type;
+export declare const enum MappedTypeModifiers {
+    IncludeReadonly = 1,
+    ExcludeReadonly = 2,
+    IncludeOptional = 4,
+    ExcludeOptional = 8
+}
+export declare function getMappedTypeModifiers(t: MappedType): MappedTypeModifiers;
+export declare function getMappedTypeOptionality(t: MappedType): number;
+export declare function getTypeFromMappedTypeNode(c: Checker, node: Node): Type;
+export declare function getTypeParameterFromMappedType(c: Checker, t: MappedType): TypeParameter;
+export declare function getConstraintTypeFromMappedType(c: Checker, t: MappedType): Type;
+export declare function getNameTypeFromMappedType(c: Checker, t: MappedType): Type | undefined;
+export declare function getTemplateTypeFromMappedType(c: Checker, t: MappedType): Type;
+export declare function isMappedTypeWithKeyofConstraintDeclaration(c: Checker, t: MappedType): boolean;
+export declare function getModifiersTypeFromMappedType(c: Checker, t: MappedType): Type;
+export declare function getHomomorphicTypeVariable(c: Checker, t: MappedType): TypeParameter | undefined;
+export declare function getActualTypeVariable(c: Checker, t: Type): Type;
+export declare const enum MappedTypeNameTypeKind {
+    None = 0,
+    Filtering = 1,
+    Remapping = 2
+}
+export declare function getMappedTypeNameTypeKind(c: Checker, t: MappedType): MappedTypeNameTypeKind;
+export declare function resolveMappedTypeMembers(c: Checker, t: MappedType): void;
+export declare function getTypeOfMappedSymbol(c: Checker, symbol: Symbol): Type;
+export declare function instantiateMappedType(c: Checker, t: MappedType, mapper: TypeMapper, alias: TypeAlias | undefined): Type;
+export declare function instantiateReverseMappedType(c: Checker, t: Type, mapper: TypeMapper): Type;
+export declare function resolveReverseMappedTypeMembers(c: Checker, t: Type): void;
+export declare function getTypeFromConditionalTypeNode(c: Checker, node: Node): Type;
+export declare function getConditionalTypeInstantiation(c: Checker, t: ConditionalType, mapper: TypeMapper, forConstraint: boolean, alias: TypeAlias | undefined): Type;
+export declare function getPermissiveInstantiation(c: Checker, t: Type): Type;
+export declare function getConditionalType(c: Checker, root: ConditionalRoot, mapper: TypeMapper | undefined, forConstraint: boolean, alias: TypeAlias | undefined): Type;
+export declare function getTrueTypeFromConditionalType(c: Checker, t: ConditionalType): Type;
+export declare function getFalseTypeFromConditionalType(c: Checker, t: ConditionalType): Type;
+/** `[getTrueTypeFromConditionalType(t), getFalseTypeFromConditionalType(t)]`, created once. */
+export declare function getBranchTypesFromConditionalType(c: Checker, t: ConditionalType): Type[];
+export declare function getInferredTrueTypeFromConditionalType(c: Checker, t: ConditionalType): Type;
+export declare function getDefaultConstraintOfConditionalType(c: Checker, t: ConditionalType): Type;
+export declare function getConstraintOfConditionalType(c: Checker, t: Type): Type | undefined;
+export declare function getConstraintFromConditionalType(c: Checker, t: Type): Type;
+/**
+ * For `T extends U ? X : Y` with a constrained check type T, the instantiation with T replaced by its
+ * constraint, which distributes over a union constraint and may reduce; `T extends undefined ? never : T`
+ * removes `undefined` from T. Restrictive instantiations have none: their type parameters are `unknown`.
+ */
+export declare function getConstraintOfDistributiveConditionalType(c: Checker, t: ConditionalType): Type | undefined;
+/** Relates a template placeholder's inferred type to the placeholder type. */
+export type TemplateTypeComparer = (source: Type, target: Type) => boolean;
+/** Whether `source` matches the pattern of `target`, with placeholders related by `compareTypes`. */
+export declare function isTypeMatchedByTemplateLiteralType(c: Checker, source: Type, target: TemplateLiteralType, compareTypes?: TemplateTypeComparer): boolean;
+/** Whether `source` is a member of a string mapping type such as `Uppercase<string>`. */
+export declare function isMemberOfStringMapping(c: Checker, source: Type, target: Type): boolean;
+export type { TupleType, UnionType };
+/** The generic mapped type an instantiated mapped type came from, or the type itself. */
+export declare function mappedTypeTarget(t: MappedType): MappedType;