Skip to content

Commit 4f7bee8

Browse files
EskiMojo14EskiMojo14
committed
objectWithPattern -> recordWithPattern
1 parent 61e49c6 commit 4f7bee8

File tree

146 files changed

+335
-335
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+335
-335
lines changed

‎library/src/schemas/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export * from './nullable/index.ts';
2626
export * from './nullish/index.ts';
2727
export * from './number/index.ts';
2828
export * from './object/index.ts';
29-
export * from './objectWithPatterns/index.ts';
29+
export * from './recordWithPatterns/index.ts';
3030
export * from './objectWithRest/index.ts';
3131
export * from './optional/index.ts';
3232
export * from './picklist/index.ts';

‎library/src/schemas/objectWithPatterns/index.ts‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎library/src/schemas/recordWithPatterns/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export * from './recordWithPatterns.ts';
2+
export * from './recordWithPatternsAsync.ts';
3+
export * from './types.ts';

library/src/schemas/objectWithPatterns/objectWithPatterns.test-d.ts renamed to library/src/schemas/recordWithPatterns/recordWithPatterns.test-d.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import type { NumberIssue, NumberSchema } from '../number/number.ts';
1010
import { number } from '../number/number.ts';
1111
import type { StringIssue, StringSchema } from '../string/string.ts';
1212
import { string } from '../string/string.ts';
13-
import type { ObjectWithPatternsSchema } from './objectWithPatterns.ts';
14-
import { objectWithPatterns } from './objectWithPatterns.ts';
15-
import type { ObjectWithPatternsIssue } from './types.ts';
13+
import type { RecordWithPatternsSchema } from './recordWithPatterns.ts';
14+
import { recordWithPatterns } from './recordWithPatterns.ts';
15+
import type { RecordWithPatternsIssue } from './types.ts';
1616

1717
const FooKeySchema = custom<`foo(${string})`>(
1818
(input) =>
@@ -29,19 +29,19 @@ const BarKeySchema = pipe(
2929
transform((input) => input.toUpperCase() as Uppercase<typeof input>)
3030
);
3131

32-
describe('objectWithPatterns', () => {
32+
describe('recordWithPatterns', () => {
3333
describe('should return schema object', () => {
3434
test('without message', () => {
3535
expectTypeOf(
36-
objectWithPatterns(
36+
recordWithPatterns(
3737
[
3838
[FooKeySchema, string()],
3939
[BarKeySchema, number()],
4040
],
4141
boolean()
4242
)
4343
).toEqualTypeOf<
44-
ObjectWithPatternsSchema<
44+
RecordWithPatternsSchema<
4545
readonly [
4646
readonly [typeof FooKeySchema, StringSchema<undefined>],
4747
readonly [typeof BarKeySchema, NumberSchema<undefined>],
@@ -53,7 +53,7 @@ describe('objectWithPatterns', () => {
5353
});
5454
test('with message', () => {
5555
expectTypeOf(
56-
objectWithPatterns(
56+
recordWithPatterns(
5757
[
5858
[FooKeySchema, string()],
5959
[BarKeySchema, number()],
@@ -62,7 +62,7 @@ describe('objectWithPatterns', () => {
6262
'message'
6363
)
6464
).toEqualTypeOf<
65-
ObjectWithPatternsSchema<
65+
RecordWithPatternsSchema<
6666
readonly [
6767
readonly [typeof FooKeySchema, StringSchema<undefined>],
6868
readonly [typeof BarKeySchema, NumberSchema<undefined>],
@@ -77,7 +77,7 @@ describe('objectWithPatterns', () => {
7777
test('of input', () => {
7878
expectTypeOf<
7979
InferInput<
80-
ObjectWithPatternsSchema<
80+
RecordWithPatternsSchema<
8181
readonly [
8282
readonly [typeof FooKeySchema, StringSchema<undefined>],
8383
readonly [typeof BarKeySchema, NumberSchema<undefined>],
@@ -96,7 +96,7 @@ describe('objectWithPatterns', () => {
9696
test('of output', () => {
9797
expectTypeOf<
9898
InferOutput<
99-
ObjectWithPatternsSchema<
99+
RecordWithPatternsSchema<
100100
readonly [
101101
readonly [typeof FooKeySchema, StringSchema<undefined>],
102102
readonly [typeof BarKeySchema, NumberSchema<undefined>],
@@ -115,7 +115,7 @@ describe('objectWithPatterns', () => {
115115
test('of issue', () => {
116116
expectTypeOf<
117117
InferIssue<
118-
ObjectWithPatternsSchema<
118+
RecordWithPatternsSchema<
119119
readonly [
120120
readonly [typeof FooKeySchema, StringSchema<undefined>],
121121
readonly [typeof BarKeySchema, NumberSchema<undefined>],
@@ -125,7 +125,7 @@ describe('objectWithPatterns', () => {
125125
>
126126
>
127127
>().toEqualTypeOf<
128-
| ObjectWithPatternsIssue
128+
| RecordWithPatternsIssue
129129
| CustomIssue
130130
| StringIssue
131131
| NumberIssue

library/src/schemas/objectWithPatterns/objectWithPatterns.test.ts renamed to library/src/schemas/recordWithPatterns/recordWithPatterns.test.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import type { FailureDataset } from '../../types/dataset.ts';
1313
import type { InferIssue } from '../../types/infer.ts';
1414
import { expectNoSchemaIssue } from '../../vitest/expectNoSchemaIssue.ts';
1515
import { expectSchemaIssue } from '../../vitest/expectSchemaIssue.ts';
16-
import type { ObjectWithPatternsSchema } from './objectWithPatterns.ts';
17-
import { objectWithPatterns } from './objectWithPatterns.ts';
18-
import type { ObjectWithPatternsIssue } from './types.ts';
16+
import type { RecordWithPatternsSchema } from './recordWithPatterns.ts';
17+
import { recordWithPatterns } from './recordWithPatterns.ts';
18+
import type { RecordWithPatternsIssue } from './types.ts';
1919

2020
const FooKeySchema = custom<`foo(${string})`>(
2121
(input) =>
@@ -32,7 +32,7 @@ const BarKeySchema = pipe(
3232
transform((input) => input.toUpperCase() as Uppercase<typeof input>)
3333
);
3434

35-
describe('objectWithPatterns', () => {
35+
describe('recordWithPatterns', () => {
3636
describe('should return schema object', () => {
3737
const patterns = [
3838
[FooKeySchema, string()],
@@ -42,12 +42,12 @@ describe('objectWithPatterns', () => {
4242
const rest = boolean();
4343
type Rest = typeof rest;
4444
const baseSchema: Omit<
45-
ObjectWithPatternsSchema<Patterns, Rest, never>,
45+
RecordWithPatternsSchema<Patterns, Rest, never>,
4646
'message'
4747
> = {
4848
kind: 'schema',
49-
type: 'object_with_patterns',
50-
reference: objectWithPatterns,
49+
type: 'record_with_patterns',
50+
reference: recordWithPatterns,
5151
expects: 'Object',
5252
patterns,
5353
rest,
@@ -60,13 +60,13 @@ describe('objectWithPatterns', () => {
6060
'~run': expect.any(Function),
6161
};
6262
test('without message', () => {
63-
expect(objectWithPatterns(patterns, rest)).toStrictEqual({
63+
expect(recordWithPatterns(patterns, rest)).toStrictEqual({
6464
...baseSchema,
6565
message: undefined,
6666
});
6767
});
6868
test('with message', () => {
69-
expect(objectWithPatterns(patterns, rest, 'message')).toStrictEqual({
69+
expect(recordWithPatterns(patterns, rest, 'message')).toStrictEqual({
7070
...baseSchema,
7171
message: 'message',
7272
});
@@ -75,13 +75,13 @@ describe('objectWithPatterns', () => {
7575
describe('should return dataset without issues', () => {
7676
test('for empty object', () => {
7777
expectNoSchemaIssue(
78-
objectWithPatterns([[FooKeySchema, string()]], boolean()),
78+
recordWithPatterns([[FooKeySchema, string()]], boolean()),
7979
[{}]
8080
);
8181
});
8282
test('for simple object', () => {
8383
expect(
84-
objectWithPatterns(
84+
recordWithPatterns(
8585
[
8686
[FooKeySchema, string()],
8787
[BarKeySchema, number()],
@@ -98,14 +98,14 @@ describe('objectWithPatterns', () => {
9898
});
9999
});
100100
describe('should return dataset with issues', () => {
101-
const schema = objectWithPatterns(
101+
const schema = recordWithPatterns(
102102
[[FooKeySchema, string()]],
103103
never(),
104104
'message'
105105
);
106-
const baseIssue: Omit<ObjectWithPatternsIssue, 'input' | 'received'> = {
106+
const baseIssue: Omit<RecordWithPatternsIssue, 'input' | 'received'> = {
107107
kind: 'schema',
108-
type: 'object_with_patterns',
108+
type: 'record_with_patterns',
109109
expected: 'Object',
110110
message: 'message',
111111
};
@@ -157,15 +157,15 @@ describe('objectWithPatterns', () => {
157157
describe('should return dataset without nested issues', () => {
158158
test('for simple object', () => {
159159
expectNoSchemaIssue(
160-
objectWithPatterns([[FooKeySchema, string()]], boolean()),
160+
recordWithPatterns([[FooKeySchema, string()]], boolean()),
161161
// @ts-expect-error
162162
[{ 'foo(bar)': 'foo', other: true }]
163163
);
164164
});
165165

166166
test('for nested object', () => {
167167
expectNoSchemaIssue(
168-
objectWithPatterns(
168+
recordWithPatterns(
169169
[[FooKeySchema, object({ key: string() })]],
170170
object({ key: number() })
171171
),
@@ -175,7 +175,7 @@ describe('objectWithPatterns', () => {
175175
});
176176
});
177177
describe('should return dataset with nested issues', () => {
178-
const schema = objectWithPatterns(
178+
const schema = recordWithPatterns(
179179
[
180180
[FooKeySchema, string()],
181181
[BarKeySchema, object({ key: number() })],

library/src/schemas/objectWithPatterns/objectWithPatterns.ts renamed to library/src/schemas/recordWithPatterns/recordWithPatterns.ts

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
_getStandardProps,
1515
_isValidObjectKey,
1616
} from '../../utils/index.ts';
17-
import type { ObjectWithPatternsIssue } from './types.ts';
17+
import type { RecordWithPatternsIssue } from './types.ts';
1818

1919
export type PatternTuple = readonly [
2020
key: BaseSchema<string, string, BaseIssue<unknown>>,
@@ -58,27 +58,27 @@ export type InferPatternsOutput<TPatterns extends PatternTuples> =
5858
? InferPatternOutput<TPattern> & InferPatternsOutput<TRest>
5959
: never;
6060

61-
export interface ObjectWithPatternsSchema<
61+
export interface RecordWithPatternsSchema<
6262
TPatterns extends PatternTuples,
6363
TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
64-
TMessage extends ErrorMessage<ObjectWithPatternsIssue> | undefined,
64+
TMessage extends ErrorMessage<RecordWithPatternsIssue> | undefined,
6565
> extends BaseSchema<
6666
Prettify<InferPatternsInput<TPatterns>> & {
6767
[key: string]: InferInput<TRest>;
6868
},
6969
Prettify<InferPatternsOutput<TPatterns>> & {
7070
[key: string]: InferOutput<TRest>;
7171
},
72-
ObjectWithPatternsIssue | InferPatternsIssue<TPatterns> | InferIssue<TRest>
72+
RecordWithPatternsIssue | InferPatternsIssue<TPatterns> | InferIssue<TRest>
7373
> {
7474
/**
7575
* The schema type.
7676
*/
77-
readonly type: 'object_with_patterns';
77+
readonly type: 'record_with_patterns';
7878
/**
7979
* The schema reference.
8080
*/
81-
readonly reference: typeof objectWithPatterns;
81+
readonly reference: typeof recordWithPatterns;
8282
/**
8383
* The expected property.
8484
*/
@@ -98,54 +98,54 @@ export interface ObjectWithPatternsSchema<
9898
}
9999

100100
/**
101-
* Creates an object schema that matches patterns.
101+
* Creates a record schema that matches patterns.
102102
*
103103
* @param patterns Pairs of key and value schemas.
104104
* @param rest Schema to use when no pattern matches.
105105
*
106-
* @returns A object schema.
106+
* @returns A record schema.
107107
*/
108-
export function objectWithPatterns<
108+
export function recordWithPatterns<
109109
const TPatterns extends PatternTuples,
110110
const TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
111111
>(
112112
patterns: TPatterns,
113113
rest: TRest
114-
): ObjectWithPatternsSchema<TPatterns, TRest, undefined>;
114+
): RecordWithPatternsSchema<TPatterns, TRest, undefined>;
115115

116116
/**
117-
* Creates an object schema that matches patterns.
117+
* Creates a record schema that matches patterns.
118118
*
119119
* @param patterns Pairs of key and value schemas.
120120
* @param rest Schema to use when no pattern matches.
121121
* @param message The error message.
122122
*
123-
* @returns A object schema.
123+
* @returns A record schema.
124124
*/
125-
export function objectWithPatterns<
125+
export function recordWithPatterns<
126126
const TPatterns extends PatternTuples,
127127
const TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
128-
const TMessage extends ErrorMessage<ObjectWithPatternsIssue> | undefined,
128+
const TMessage extends ErrorMessage<RecordWithPatternsIssue> | undefined,
129129
>(
130130
patterns: TPatterns,
131131
rest: TRest,
132132
message: TMessage
133-
): ObjectWithPatternsSchema<TPatterns, TRest, TMessage>;
133+
): RecordWithPatternsSchema<TPatterns, TRest, TMessage>;
134134

135135
// @__NO_SIDE_EFFECTS__
136-
export function objectWithPatterns(
136+
export function recordWithPatterns(
137137
patterns: PatternTuples,
138138
rest: BaseSchema<unknown, unknown, BaseIssue<unknown>>,
139-
message?: ErrorMessage<ObjectWithPatternsIssue>
140-
): ObjectWithPatternsSchema<
139+
message?: ErrorMessage<RecordWithPatternsIssue>
140+
): RecordWithPatternsSchema<
141141
PatternTuples,
142142
BaseSchema<unknown, unknown, BaseIssue<unknown>>,
143-
ErrorMessage<ObjectWithPatternsIssue> | undefined
143+
ErrorMessage<RecordWithPatternsIssue> | undefined
144144
> {
145145
return {
146146
kind: 'schema',
147-
type: 'object_with_patterns',
148-
reference: objectWithPatterns,
147+
type: 'record_with_patterns',
148+
reference: recordWithPatterns,
149149
expects: 'Object',
150150
async: false,
151151
patterns,
@@ -245,7 +245,7 @@ export function objectWithPatterns(
245245
// @ts-expect-error
246246
return dataset as OutputDataset<
247247
InferPatternsOutput<PatternTuples> & { [key: string]: unknown },
248-
| ObjectWithPatternsIssue
248+
| RecordWithPatternsIssue
249249
| InferPatternsIssue<PatternTuples>
250250
| BaseIssue<unknown>
251251
>;

0 commit comments

Comments
 (0)