Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion etc/types.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -666,13 +666,15 @@ export interface Visitor<R> {
// (undocumented)
visitCustomType(type: BaseTypeImpl<unknown>): R;
// (undocumented)
visitIntersectionType(type: IntersectionType<OneOrMore<BaseObjectLikeTypeImpl<unknown>>>): R;
// (undocumented)
visitKeyofType(type: KeyofType<Record<any, any>, any>): R;
// (undocumented)
visitLiteralType(type: LiteralType<LiteralValue>): R;
// (undocumented)
visitNumberType(type: BaseTypeImpl<number, NumberTypeConfig>): R;
// (undocumented)
visitObjectLikeType(type: BaseObjectLikeTypeImpl<unknown>): R;
visitObjectType(type: InterfaceType<Properties, unknownRecord>): R;
// (undocumented)
visitRecordType(type: RecordType<BaseTypeImpl<number | string>, number | string, BaseTypeImpl<unknown>, unknown>): R;
// (undocumented)
Expand Down
3 changes: 2 additions & 1 deletion markdown/types.visitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ interface Visitor<R>
| [visitArrayType(type)](./types.visitor.visitarraytype.md) | |
| [visitBooleanType(type)](./types.visitor.visitbooleantype.md) | |
| [visitCustomType(type)](./types.visitor.visitcustomtype.md) | |
| [visitIntersectionType(type)](./types.visitor.visitintersectiontype.md) | |
| [visitKeyofType(type)](./types.visitor.visitkeyoftype.md) | |
| [visitLiteralType(type)](./types.visitor.visitliteraltype.md) | |
| [visitNumberType(type)](./types.visitor.visitnumbertype.md) | |
| [visitObjectLikeType(type)](./types.visitor.visitobjectliketype.md) | |
| [visitObjectType(type)](./types.visitor.visitobjecttype.md) | |
| [visitRecordType(type)](./types.visitor.visitrecordtype.md) | |
| [visitStringType(type)](./types.visitor.visitstringtype.md) | |
| [visitUnionType(type)](./types.visitor.visituniontype.md) | |
Expand Down
21 changes: 21 additions & 0 deletions markdown/types.visitor.visitintersectiontype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@skunkteam/types](./types.md) &gt; [Visitor](./types.visitor.md) &gt; [visitIntersectionType](./types.visitor.visitintersectiontype.md)

## Visitor.visitIntersectionType() method

**Signature:**

```typescript
visitIntersectionType(type: IntersectionType<OneOrMore<BaseObjectLikeTypeImpl<unknown>>>): R;
```

## Parameters

| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| type | [IntersectionType](./types.intersectiontype.md)<!-- -->&lt;[OneOrMore](./types.oneormore.md)<!-- -->&lt;[BaseObjectLikeTypeImpl](./types.baseobjectliketypeimpl.md)<!-- -->&lt;unknown&gt;&gt;&gt; | |

**Returns:**

R
21 changes: 0 additions & 21 deletions markdown/types.visitor.visitobjectliketype.md

This file was deleted.

21 changes: 21 additions & 0 deletions markdown/types.visitor.visitobjecttype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@skunkteam/types](./types.md) &gt; [Visitor](./types.visitor.md) &gt; [visitObjectType](./types.visitor.visitobjecttype.md)

## Visitor.visitObjectType() method

**Signature:**

```typescript
visitObjectType(type: InterfaceType<Properties, unknownRecord>): R;
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| type | [InterfaceType](./types.interfacetype.md)<!-- -->&lt;[Properties](./types.properties.md)<!-- -->, [unknownRecord](./types.unknownrecord.md)<!-- -->&gt; | |

**Returns:**

R
11 changes: 6 additions & 5 deletions src/interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { BaseObjectLikeTypeImpl, BaseTypeImpl } from './base-type';
import type { brands, designType } from './symbols';
import type { ArrayType, KeyofType, LiteralType, RecordType, UnionType } from './types';
import type { ArrayType, InterfaceType, IntersectionType, KeyofType, LiteralType, RecordType, UnionType, unknownRecord } from './types';

/**
* A type-validator/-parser that validates or parses `ResultType`.
Expand Down Expand Up @@ -422,17 +422,18 @@ export interface ArrayTypeConfig extends LengthChecksConfig {
export interface Visitor<R> {
visitArrayType(type: ArrayType<BaseTypeImpl<unknown>, unknown, unknown[]>): R;
visitBooleanType(type: BaseTypeImpl<boolean>): R;
visitObjectLikeType(type: BaseObjectLikeTypeImpl<unknown>): R;
visitCustomType(type: BaseTypeImpl<unknown>): R;
visitIntersectionType(type: IntersectionType<OneOrMore<BaseObjectLikeTypeImpl<unknown>>>): R;
visitKeyofType(type: KeyofType<Record<any, any>, any>): R;
visitLiteralType(type: LiteralType<LiteralValue>): R;
visitNumberType(type: BaseTypeImpl<number, NumberTypeConfig>): R;
visitObjectType(type: InterfaceType<Properties, unknownRecord>): R;
visitRecordType(type: RecordType<BaseTypeImpl<number | string>, number | string, BaseTypeImpl<unknown>, unknown>): R;
visitStringType(type: BaseTypeImpl<string, StringTypeConfig>): R;
visitUnionType(type: UnionType<OneOrMore<BaseTypeImpl<unknown>>, unknown>): R;
visitUnknownType(type: BaseTypeImpl<unknown>): R;
visitUnknownRecordType(type: BaseTypeImpl<Record<string, unknown>>): R;
visitUnknownArrayType(type: BaseTypeImpl<unknown[]>): R;
visitCustomType(type: BaseTypeImpl<unknown>): R;
visitUnknownRecordType(type: BaseTypeImpl<Record<string, unknown>>): R;
visitUnknownType(type: BaseTypeImpl<unknown>): R;
}

/**
Expand Down
10 changes: 7 additions & 3 deletions src/testutils.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable @typescript-eslint/no-unsafe-return */

import type { BaseObjectLikeTypeImpl, BaseTypeImpl } from './base-type';
import type { BasicType, LiteralValue, NumberTypeConfig, OneOrMore, StringTypeConfig, Type, Visitor } from './interfaces';
import type { ArrayType, KeyofType, LiteralType, RecordType, UnionType } from './types';
import type { BasicType, LiteralValue, NumberTypeConfig, OneOrMore, Properties, StringTypeConfig, Type, Visitor } from './interfaces';
import type { ArrayType, InterfaceType, IntersectionType, KeyofType, LiteralType, RecordType, UnionType, unknownRecord } from './types';
import { an, basicType, printValue } from './utils';
import { ValidationError } from './validation-error';

Expand Down Expand Up @@ -140,7 +140,11 @@ class CreateExampleVisitor implements Visitor<unknown> {
return [true, false][this.seed++ % 2];
}

visitObjectLikeType(type: BaseObjectLikeTypeImpl<unknown>): unknown {
visitIntersectionType(type: IntersectionType<OneOrMore<BaseObjectLikeTypeImpl<unknown>>>): unknown {
return Object.assign({}, ...type.types.map(t => t.accept(this)));
}

visitObjectType(type: InterfaceType<Properties, unknownRecord>): unknown {
if (hasExample(type)) return type.example;
return Object.fromEntries(Object.entries(type.props).map(([key, propType]) => [key, propType.accept(this)]));
}
Expand Down
2 changes: 1 addition & 1 deletion src/types/interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ export class InterfaceType<Props extends Properties, ResultType extends unknownR

/** {@inheritdoc BaseTypeImpl.accept} */
accept<R>(visitor: Visitor<R>): R {
return visitor.visitObjectLikeType(this);
return visitor.visitObjectType(this as InterfaceType<Properties, unknownRecord>);
}

/** {@inheritdoc BaseTypeImpl.maybeStringify} */
Expand Down
2 changes: 1 addition & 1 deletion src/types/intersection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export class IntersectionType<Types extends OneOrMore<BaseObjectLikeTypeImpl<unk

/** {@inheritdoc BaseTypeImpl.accept} */
accept<R>(visitor: Visitor<R>): R {
return visitor.visitObjectLikeType(this);
return visitor.visitIntersectionType(this);
}

/** {@inheritdoc BaseTypeImpl.maybeStringify} */
Expand Down