Getting Started

Get up and running with TypeORM Scopes in 5 minutes.

Installation

Install the package using your preferred package manager:

npm

npm install typeorm-query-scopes

yarn

yarn add typeorm-query-scopes

pnpm

pnpm add typeorm-query-scopes

Prerequisites

• TypeORM 0.3.0 or higher
• TypeScript 5.0 or higher
• Node.js 16.0 or higher

TypeScript Configuration

Make sure your tsconfig.json has these settings:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "strict": true
  }
}

Basic Setup

1. Define Scopes on Your Entity

import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
import { Scopes, DefaultScope } from 'typeorm-query-scopes';

@DefaultScope<User>({
  where: { isActive: true }
})
@Scopes<User>({
  verified: {
    where: { isVerified: true }
  },
  admin: {
    where: { role: 'admin' }
  }
})
@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  email: string;

  @Column()
  role: string;

  @Column({ default: true })
  isActive: boolean;

  @Column({ default: false })
  isVerified: boolean;
}

2. Use Scoped Repository

import { getScopedRepository } from 'typeorm-query-scopes';
import { dataSource } from './data-source';
import { User } from './entities/User';

// Create a scoped repository
const userRepo = getScopedRepository(User, dataSource);

// Use scopes
const verifiedUsers = await userRepo.scope('verified').find();
const admins = await userRepo.scope('admin').find();
const verifiedAdmins = await userRepo.scope('verified', 'admin').find();

// Remove default scope
const allUsers = await userRepo.unscoped().find();

Next Steps

• Learn about Default Scopes
• Explore Named Scopes
• Try Function Scopes
• Understand Scope Merging
• Enable Type-Safe Scopes

Need Help?

• Check the API Reference
• Browse Examples
• Open an issue on GitHub