Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[types/factory_girl] Make factory can be used named import / Add override definitions for seq and sequence #50420

Merged
merged 4 commits into from
Jan 9, 2021
Merged

[types/factory_girl] Make factory can be used named import / Add override definitions for seq and sequence #50420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3842db
The `factory` variable can be imported as named import.
ishikawa Jan 6, 2021
5a09635
Add override definitions for `seq` and `sequence`.
ishikawa Jan 6, 2021
5db412e
Remove template literal from test
ishikawa Jan 6, 2021
e8881a9
Disable TSLint no-duplicate-imports rule
ishikawa Jan 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions types/factory-girl/factory-girl-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import * as factory from "factory-girl";
// tslint:disable-next-line:no-duplicate-imports
import { factory as namedImportedFactory } from "factory-girl";

interface User {
username?: string;
Expand Down Expand Up @@ -28,6 +30,24 @@ const scoreSequence = factory.sequence<number>(
);
const scoreSeq = factory.seq<number>('User.score', score => score + 1);

// Testing sequence with no params
// $ExpectType Generator<number>
factory.seq();
// $ExpectType Generator<number>
factory.sequence();

// Testing sequence with id
// $ExpectType Generator<number>
factory.seq('User.score');
// $ExpectType Generator<number>
factory.sequence('User.score');

// Testing sequence with callback
// $ExpectType Generator<string>
factory.seq(value => value.toString());
// $ExpectType Generator<string>
factory.sequence(value => value.toString());

// Testing sequence resetting
factory.resetSeq();
factory.resetSequence();
Expand Down Expand Up @@ -124,3 +144,6 @@ factory

// Testing cleanUp
factory.cleanUp();

// Testing namedImportedFactory
namedImportedFactory.seq();
7 changes: 7 additions & 0 deletions types/factory-girl/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ declare namespace factory {
}>;

interface Static {
factory: Static;

/**
* Associate the factory to other model
*/
Expand Down Expand Up @@ -84,8 +86,13 @@ declare namespace factory {
/**
* Generate values sequentially inside a factory
*/
seq(name?: string): Generator<number>;
seq<T>(name: string, fn: (sequence: number) => T): Generator<T>;
seq<T>(fn: (sequence: number) => T): Generator<T>;

sequence(name?: string): Generator<number>;
sequence<T>(name: string, fn: (sequence: number) => T): Generator<T>;
sequence<T>(fn: (sequence: number) => T): Generator<T>;

/**
* Register an adapter, either as default or tied to a specific model
Expand Down