Package Exports

typeorm-faker
typeorm-faker/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typeorm-faker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TypeORM-Faker

Generate fake mocks, stubs using your entity settings.

Install

npm install --save-dev typeorm-faker

Usage

// import typeorm faker on your test file.
import typeormFaker from 'typeorm-faker';

// here is entity
@Entity('post')
export class Post {
    @PrimaryGeneratedColumn()
    id!: number;

    @Column()
    title!: string;

    @Column()
    text?: string;

    @Column({
        nullable: false,
        default: 0
    })
    likesCount!: number;
}

// generate stubs
const postStubs = typeormFaker.stub(Post);

/**
 * You can specify values for fake entity
 *
 * Post [
 *     { id: 1, title: 'this is test title', text: 'eW2p3tj*A', likesCount: 0 },
 *     { id: 1, title: 'this is test title', text: 'abcdef', likesCount: 0 }
 * ]
 */
const count = 5;
const postStubs = typeormFaker.stub(Post, count, {
    id: 1,
    title: 'this is test title'
});

// or one
/**
 * Post { id: 13326, title: 'pDYFMFO,ZX', text: 'eW2p3tj*A', likesCount: 0 }
 */
const postStub = typeormFaker.stubOne(Post);

/**
 * Post { id: 1, ... }
 */
const postStub = typeormFaker.stubOne(Post, {
    id: 1
});

/**
 * you can generate also typeorm raw one for type inference
 *
 * Post {
 *     post_id: 13326,
 *     post_title: 'pDYFMFO,ZX',
 *     post_text: 'eW2`p3tj*A',
 *     post_likesCount: 0`
 * }
 */
const rawPostStub = typeormFaker.stubRawOne<Post, 'Post', ''>(Post);
const rawPostStub = typeormFaker.stubRawOne<Post, 'Post', ''>(Post, {
    // post_id
    // post_title ...
});

const count = 2;
const rawPostStubArray = typeormFaker.stubRaw<Post, 'Post', ''>(Post, count, {
    post_id: 12345
});

Support Type-Inference for TypeORM Raw Entity

Use typeormFaker object globally

Register

you can configure register for global use

// bootload.ts
import typeormFaker from 'typeorm-faker';

(globalThis as any).typeormFaker = typeormFaker;

Set register file as require settings

- typeorm-faker/registers
- scripts/bootload.ts

For global type

add typings/sample/index.d.ts

// projectRoot/typings/sample/index.d.ts
declare const typeormFaker: TypeORMFaker.TypeORMFakerStatic;

// you can also declare sutb / stubOne function globally
declare const stub: TypeORMFaker.StubStatic;
declare const stubOne: TypeORMFaker.StubOneStatic;

then setting up to tsconfig.json

# set typeRoots on tsconfig.json
{
    // ...,
    "typeRoots": [
        //   "node_modules/@types", // add for @types for other packages nor delete it.
        "node_modules/typeorm-faker/@types"
    ],
    "types": [
        "sample"
    ]
}

Limitations

For type inference of TypeORM raw entity, Typescript does not yet support the way that getting class name from generics. So, you must specify class variable and that name, additional fields when you use.

JSPM

typeorm-faker