Backend

NestJS specific style guide and conventions

Entities

Node

Entities should always extend Node unless it is absolutely not possible.

@ObjectType()
@Entity('addresses')
export class Address extends Node {
    ....
}

Decorators

Decorators must be placed in the following order

1. Any other decorators, such as type validators (e.g. IsPhoneNumber)

2. GraphQL Field decorator

3. TypeORM Column decorator

Descriptions

All Field decorators must supply the description property.

@ObjectType({ description: 'Single address record' })
export class Address extends Node {
	@Field({ description: 'Line 1 of the address' })
	line1: string;

	@Field({ description: 'Line 2 of the address', nullable: true })
	line2?: string;

	@Field({ description: 'Address city' })
	city: string;

	@Field({ description: 'Address county' })
	county: string;

	@Field({ description: 'Postal/zip code' })
	postCode: string;

	@Field({ description: 'ISO country code' })
	countryCode: string;
}

Resolvers

A resolver can be:

• A mutation

• A query

• A field

A resolver file must not contain more than 1 mutation.

A resolver file should not contain more than 1 query.

A resolver file may contain more than 1 field resolver.