fullstack.org.ua

Built-in Pipes · fullstack.org.ua

Середній13 хв· Fullstack Team

Built-in Pipes

Використаєте вбудовані ParseIntPipe, ParseBoolPipe, ParseUUIDPipe та інші pipes для перетворення й перевірки параметрів.

Що роблять вбудовані pipes

Pipe у NestJS — це клас, який обробляє значення перед передаванням його в метод контролера. Вбудовані pipes найчастіше використовують для:

перетворення рядків із URL або query-параметрів у потрібний тип;
перевірки формату значення;
встановлення значення за замовчуванням;
відхилення некоректного запиту з помилкою 400 Bad Request.

Параметри HTTP-запиту спочатку надходять у застосунок як рядки. Наприклад, значення id із маршруту /users/42 буде рядком "42", навіть якщо в TypeScript параметр оголошений як number.

typescript

@Get(':id')
findOne(@Param('id') id: number) {
  // Без pipe тут фактично буде string
  return this.usersService.findOne(id);
}

typescript

import { Controller, Get, Param, ParseIntPipe } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get(':id')
  findOne(@Param('id', ParseIntPipe) id: number) {
    return {
      id,
      type: typeof id,
    };
  }
}

typescript

import {
  Controller,
  Get,
  ParseFloatPipe,
  Query,
} from '@nestjs/common';

@Controller('products')
export class ProductsController {
  @Get()
  findByPrice(
    @Query('minPrice', ParseFloatPipe) minPrice: number,
  ) {
    return {
      minPrice,
      type: typeof minPrice,
    };
  }
}

typescript

import {
  Controller,
  Get,
  ParseBoolPipe,
  Query,
} from '@nestjs/common';

@Controller('products')
export class ProductsController {
  @Get()
  findAll(
    @Query('available', ParseBoolPipe) available: boolean,
  ) {
    return {
      available,
      type: typeof available,
    };
  }
}

typescript

import {
  Controller,
  Get,
  Param,
  ParseUUIDPipe,
} from '@nestjs/common';

@Controller('orders')
export class OrdersController {
  @Get(':id')
  findOne(
    @Param('id', ParseUUIDPipe) id: string,
  ) {
    return {
      id,
      message: 'Замовлення знайдено',
    };
  }
}

typescript

import {
  Controller,
  Get,
  ParseEnumPipe,
  Query,
} from '@nestjs/common';

enum ProductSort {
  Price = 'price',
  Name = 'name',
  CreatedAt = 'createdAt',
}

@Controller('products')
export class ProductsController {
  @Get()
  findAll(
    @Query('sort', new ParseEnumPipe(ProductSort))
    sort: ProductSort,
  ) {
    return {
      sort,
    };
  }
}

typescript

import {
  Controller,
  DefaultValuePipe,
  Get,
  ParseIntPipe,
  Query,
} from '@nestjs/common';

@Controller('products')
export class ProductsController {
  @Get()
  findAll(
    @Query('page', new DefaultValuePipe(1), ParseIntPipe)
    page: number,
  ) {
    return {
      page,
    };
  }
}

typescript

import {
  Controller,
  Get,
  ParseArrayPipe,
  Query,
} from '@nestjs/common';

@Controller('products')
export class ProductsController {
  @Get()
  findMany(
    @Query(
      'ids',
      new ParseArrayPipe({ items: Number }),
    )
    ids: number[],
  ) {
    return {
      ids,
      typeOfFirstItem: typeof ids[0],
    };
  }
}

typescript

import {
  Controller,
  Get,
  Param,
  ParseBoolPipe,
  ParseIntPipe,
  Query,
} from '@nestjs/common';

@Controller('reports')
export class ReportsController {
  @Get(':reportId')
  getReport(
    @Param('reportId', ParseIntPipe) reportId: number,
    @Query('includeDetails', ParseBoolPipe) includeDetails: boolean,
  ) {
    return {
      reportId,
      includeDetails,
    };
  }
}

typescript

import {
  Controller,
  DefaultValuePipe,
  Get,
  Param,
  ParseArrayPipe,
  ParseBoolPipe,
  ParseEnumPipe,
  ParseIntPipe,
  ParseUUIDPipe,
  Query,
} from '@nestjs/common';

enum OrderStatus {
  Pending = 'pending',
  Paid = 'paid',
  Cancelled = 'cancelled',
}

@Controller('orders')
export class OrdersController {
  @Get()
  findAll(
    @Query('page', new DefaultValuePipe(1), ParseIntPipe)
    page: number,

    @Query('includeCancelled', ParseBoolPipe)
    includeCancelled: boolean,

    @Query(
      'ids',
      new ParseArrayPipe({ items: Number }),
    )
    ids: number[],

    @Query('status', new ParseEnumPipe(OrderStatus))
    status: OrderStatus,
  ) {
    return {
      page,
      includeCancelled,
      ids,
      status,
    };
  }

  @Get(':id')
  findOne(
    @Param('id', ParseUUIDPipe)
    id: string,
  ) {
    return {
      id,
    };
  }
}

typescript

@Get()
findAll(
  @Query('page', new DefaultValuePipe(1), ParseIntPipe)
  page: number,

  @Query(
    'includeDetails',
    new DefaultValuePipe(false),
    ParseBoolPipe,
  )
  includeDetails: boolean,
) {
  return {
    page,
    includeDetails,
  };
}