@kubb/plugin-faker 5.4.0-canary.20261111T122006 → 5.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +255 -289
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +8 -9
- package/dist/index.d.ts +8 -9
- package/dist/index.js +255 -289
- package/dist/index.js.map +1 -1
- package/docs/options.md +14 -11
- package/docs/overview.md +2 -2
- package/kubb-extension.json +1 -1
- package/package.json +6 -6
package/dist/index.d.cts
CHANGED
|
@@ -15,7 +15,7 @@ type ResolverFaker = Resolver & {
|
|
|
15
15
|
* Resolves the faker function name for an individual parameter.
|
|
16
16
|
*
|
|
17
17
|
* @example Individual parameter name
|
|
18
|
-
* `resolver.param.name(node, param) // -> '
|
|
18
|
+
* `resolver.param.name(node, param) // -> 'createShowPetByIdPathPetId'`
|
|
19
19
|
*/
|
|
20
20
|
name(node: ast.OperationNode, param: ast.ParameterNode): string;
|
|
21
21
|
/**
|
|
@@ -55,28 +55,28 @@ type ResolverFaker = Resolver & {
|
|
|
55
55
|
* Resolves the faker function name for a response by status code.
|
|
56
56
|
*
|
|
57
57
|
* @example Response status name
|
|
58
|
-
* `resolver.response.status(node, 200) // -> '
|
|
58
|
+
* `resolver.response.status(node, 200) // -> 'createListPetsStatus200'`
|
|
59
59
|
*/
|
|
60
60
|
status(node: ast.OperationNode, statusCode: ast.StatusCode): string;
|
|
61
61
|
/**
|
|
62
62
|
* Resolves the faker function name for a request body.
|
|
63
63
|
*
|
|
64
64
|
* @example Request body name
|
|
65
|
-
* `resolver.response.body(node) // -> '
|
|
65
|
+
* `resolver.response.body(node) // -> 'createCreatePetsBody'`
|
|
66
66
|
*/
|
|
67
67
|
body(node: ast.OperationNode): string;
|
|
68
68
|
/**
|
|
69
69
|
* Resolves the faker function name for the response union.
|
|
70
70
|
*
|
|
71
71
|
* @example Response union name
|
|
72
|
-
* `resolver.response.response(node) // -> '
|
|
72
|
+
* `resolver.response.response(node) // -> 'createListPetsResponse'`
|
|
73
73
|
*/
|
|
74
74
|
response(node: ast.OperationNode): string;
|
|
75
75
|
/**
|
|
76
76
|
* Resolves the faker function name for the response collection.
|
|
77
77
|
*
|
|
78
78
|
* @example Responses collection name
|
|
79
|
-
* `resolver.response.responses(node) // -> '
|
|
79
|
+
* `resolver.response.responses(node) // -> 'createListPetsResponses'`
|
|
80
80
|
*/
|
|
81
81
|
responses(node: ast.OperationNode): string;
|
|
82
82
|
};
|
|
@@ -116,8 +116,8 @@ type Options = OutputOptions & {
|
|
|
116
116
|
dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
|
|
117
117
|
/**
|
|
118
118
|
* Library used to generate strings that satisfy a regex `pattern` keyword.
|
|
119
|
-
* - `'faker'` uses `faker.helpers.fromRegExp`. No extra dependency.
|
|
120
|
-
*
|
|
119
|
+
* - `'faker'` uses `faker.helpers.fromRegExp`. No extra dependency. Kubb rewrites `\d`, `\w`, escaped
|
|
120
|
+
* characters, and `{n,}` for faker. Groups, alternation, and `\s` need `'randexp'`.
|
|
121
121
|
* - `'randexp'` uses the `randexp` package. Supports a wider regex grammar.
|
|
122
122
|
*
|
|
123
123
|
* @default 'faker'
|
|
@@ -296,5 +296,4 @@ export declare const pluginFaker: import("@kubb/kit").PluginFactory<PluginFaker>
|
|
|
296
296
|
* ```
|
|
297
297
|
*/
|
|
298
298
|
export declare const resolverFaker: ResolverFaker;
|
|
299
|
-
export { type PluginFaker, type PrinterFakerFactory, type PrinterFakerNodes, type PrinterFakerOptions, type ResolverFaker, pluginFaker as default };
|
|
300
|
-
//# sourceMappingURL=index.d.cts.map
|
|
299
|
+
export { type PluginFaker, type PrinterFakerFactory, type PrinterFakerNodes, type PrinterFakerOptions, type ResolverFaker, pluginFaker as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ type ResolverFaker = Resolver & {
|
|
|
15
15
|
* Resolves the faker function name for an individual parameter.
|
|
16
16
|
*
|
|
17
17
|
* @example Individual parameter name
|
|
18
|
-
* `resolver.param.name(node, param) // -> '
|
|
18
|
+
* `resolver.param.name(node, param) // -> 'createShowPetByIdPathPetId'`
|
|
19
19
|
*/
|
|
20
20
|
name(node: ast.OperationNode, param: ast.ParameterNode): string;
|
|
21
21
|
/**
|
|
@@ -55,28 +55,28 @@ type ResolverFaker = Resolver & {
|
|
|
55
55
|
* Resolves the faker function name for a response by status code.
|
|
56
56
|
*
|
|
57
57
|
* @example Response status name
|
|
58
|
-
* `resolver.response.status(node, 200) // -> '
|
|
58
|
+
* `resolver.response.status(node, 200) // -> 'createListPetsStatus200'`
|
|
59
59
|
*/
|
|
60
60
|
status(node: ast.OperationNode, statusCode: ast.StatusCode): string;
|
|
61
61
|
/**
|
|
62
62
|
* Resolves the faker function name for a request body.
|
|
63
63
|
*
|
|
64
64
|
* @example Request body name
|
|
65
|
-
* `resolver.response.body(node) // -> '
|
|
65
|
+
* `resolver.response.body(node) // -> 'createCreatePetsBody'`
|
|
66
66
|
*/
|
|
67
67
|
body(node: ast.OperationNode): string;
|
|
68
68
|
/**
|
|
69
69
|
* Resolves the faker function name for the response union.
|
|
70
70
|
*
|
|
71
71
|
* @example Response union name
|
|
72
|
-
* `resolver.response.response(node) // -> '
|
|
72
|
+
* `resolver.response.response(node) // -> 'createListPetsResponse'`
|
|
73
73
|
*/
|
|
74
74
|
response(node: ast.OperationNode): string;
|
|
75
75
|
/**
|
|
76
76
|
* Resolves the faker function name for the response collection.
|
|
77
77
|
*
|
|
78
78
|
* @example Responses collection name
|
|
79
|
-
* `resolver.response.responses(node) // -> '
|
|
79
|
+
* `resolver.response.responses(node) // -> 'createListPetsResponses'`
|
|
80
80
|
*/
|
|
81
81
|
responses(node: ast.OperationNode): string;
|
|
82
82
|
};
|
|
@@ -116,8 +116,8 @@ type Options = OutputOptions & {
|
|
|
116
116
|
dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
|
|
117
117
|
/**
|
|
118
118
|
* Library used to generate strings that satisfy a regex `pattern` keyword.
|
|
119
|
-
* - `'faker'` uses `faker.helpers.fromRegExp`. No extra dependency.
|
|
120
|
-
*
|
|
119
|
+
* - `'faker'` uses `faker.helpers.fromRegExp`. No extra dependency. Kubb rewrites `\d`, `\w`, escaped
|
|
120
|
+
* characters, and `{n,}` for faker. Groups, alternation, and `\s` need `'randexp'`.
|
|
121
121
|
* - `'randexp'` uses the `randexp` package. Supports a wider regex grammar.
|
|
122
122
|
*
|
|
123
123
|
* @default 'faker'
|
|
@@ -296,5 +296,4 @@ export declare const pluginFaker: import("@kubb/kit").PluginFactory<PluginFaker>
|
|
|
296
296
|
* ```
|
|
297
297
|
*/
|
|
298
298
|
export declare const resolverFaker: ResolverFaker;
|
|
299
|
-
export { type PluginFaker, type PrinterFakerFactory, type PrinterFakerNodes, type PrinterFakerOptions, type ResolverFaker, pluginFaker as default };
|
|
300
|
-
//# sourceMappingURL=index.d.ts.map
|
|
299
|
+
export { type PluginFaker, type PrinterFakerFactory, type PrinterFakerNodes, type PrinterFakerOptions, type ResolverFaker, pluginFaker as default };
|