Updated API docs.

skunkteam · Nov 18, 2024 · 2888f0f · 2888f0f
1 parent a282744
commit 2888f0f
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 21 deletions.
diff --git a/etc/types.api.md b/etc/types.api.md
@@ -427,8 +427,10 @@ export type PropertyInfo<T extends Type<unknown> = Type<unknown>> = {
     type: T;
 };
 
+// Warning: (ae-forgotten-export) The symbol "Unwidened" needs to be exported by the entry point index.d.ts
+//
 // @public
-export function record<KeyType extends number | string, ValueType>(...args: [name: string, keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<ValueType>, strict?: boolean] | [keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<ValueType>, strict?: boolean]): TypeImpl<RecordType<BaseTypeImpl<KeyType>, KeyType, BaseTypeImpl<ValueType>, ValueType>>;
+export function record<KeyType extends number | string, ValueType>(...args: [name: string, keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<Unwidened<ValueType>>, strict?: boolean] | [keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<Unwidened<ValueType>>, strict?: boolean]): TypeImpl<RecordType<BaseTypeImpl<KeyType>, KeyType, BaseTypeImpl<ValueType>, ValueType>>;
 
 // @public
 export class RecordType<KeyTypeImpl extends BaseTypeImpl<KeyType>, KeyType extends number | string, ValueTypeImpl extends BaseTypeImpl<ValueType>, ValueType, ResultType extends Record<KeyType, ValueType> = Record<KeyType, ValueType>> extends BaseTypeImpl<ResultType> {

diff --git a/markdown/types.record.md b/markdown/types.record.md
@@ -11,16 +11,16 @@ Note: record has strict validation by default, while type does not have strict v
 ```typescript
 declare function record<KeyType extends number | string, ValueType>(
     ...args:
-        | [name: string, keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<ValueType>, strict?: boolean]
-        | [keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<ValueType>, strict?: boolean]
+        | [name: string, keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<Unwidened<ValueType>>, strict?: boolean]
+        | [keyType: BaseTypeImpl<KeyType>, valueType: BaseTypeImpl<Unwidened<ValueType>>, strict?: boolean]
 ): TypeImpl<RecordType<BaseTypeImpl<KeyType>, KeyType, BaseTypeImpl<ValueType>, ValueType>>;
 ```
 
 ## Parameters
 
-| Parameter | Type                                                                                                                                                                                                                                                                                                                                                                   | Description |
-| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| args      | \[name: string, keyType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;KeyType&gt;, valueType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;ValueType&gt;, strict?: boolean\] \| \[keyType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;KeyType&gt;, valueType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;ValueType&gt;, strict?: boolean\] |             |
+| Parameter | Type                                                                                                                                                                                                                                                                                                                                                                                                     | Description |
+| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
+| args      | \[name: string, keyType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;KeyType&gt;, valueType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;Unwidened&lt;ValueType&gt;&gt;, strict?: boolean\] \| \[keyType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;KeyType&gt;, valueType: [BaseTypeImpl](./types.basetypeimpl.md)<!-- -->&lt;Unwidened&lt;ValueType&gt;&gt;, strict?: boolean\] |             |
 
 **Returns:**
 

diff --git a/src/types/intersection.ts b/src/types/intersection.ts
@@ -43,10 +43,7 @@ export class IntersectionType<Types extends OneOrMore<BaseObjectLikeTypeImpl<unk
     /** {@inheritdoc BaseTypeImpl.typeConfig} */
     readonly typeConfig: undefined;
 
-    constructor(
-        readonly types: Types,
-        name?: string,
-    ) {
+    constructor(readonly types: Types, name?: string) {
         super();
         this.isDefaultName = !name;
         this.name = name || defaultName(types);

diff --git a/src/types/number.ts b/src/types/number.ts
@@ -103,7 +103,7 @@ type Bound<T extends 'min' | 'max'> = {
 function selectBound<T extends 'min' | 'max'>(key: T, current: NumberTypeConfig, update: NumberTypeConfig): Bound<T> {
     const exclKey = `${key}Exclusive` as const;
 
-    const onlyTheBound = (c: NumberTypeConfig) => ({ [key]: c[key], [exclKey]: c[exclKey] }) as Bound<T>;
+    const onlyTheBound = (c: NumberTypeConfig) => ({ [key]: c[key], [exclKey]: c[exclKey] } as Bound<T>);
 
     const currentPosition: number | undefined = current[key] ?? current[exclKey];
     if (currentPosition == null) return onlyTheBound(update);

diff --git a/src/types/record.ts b/src/types/record.ts
@@ -23,12 +23,7 @@ export class RecordType<
     /** {@inheritdoc BaseTypeImpl.typeConfig} */
     readonly typeConfig: undefined;
 
-    constructor(
-        readonly keyType: KeyTypeImpl,
-        readonly valueType: ValueTypeImpl,
-        name?: string,
-        readonly strict = true,
-    ) {
+    constructor(readonly keyType: KeyTypeImpl, readonly valueType: ValueTypeImpl, name?: string, readonly strict = true) {
         super();
         this.isDefaultName = !name;
         this.name = name || `Record<${keyType.name}, ${valueType.name}>`;

diff --git a/src/types/union.ts b/src/types/union.ts
@@ -31,10 +31,7 @@ export class UnionType<
     /** {@inheritdoc BaseTypeImpl.typeConfig} */
     readonly typeConfig: undefined;
 
-    constructor(
-        readonly types: Types,
-        name?: string,
-    ) {
+    constructor(readonly types: Types, name?: string) {
         super();
         this.isDefaultName = !name;
         this.name = name || types.map(type => bracketsIfNeeded(type.name, '|')).join(' | ');