fix(docs): describe typed-headers

README.md

@@ -42,6 +42,37 @@ All of the decorators support the following parameters:
 
 Also decorators have additional parameters like: `min`, `max` for `IsNumber`.
 
+### Headers validation
+
+You can also validate request headers using `TypedHeaders` decorator.
+
+```ts
+export class TestHeaders {
+  @IsString({
+    // Note: header names will be lowercased automatically
+    name: 'country-code',
+    maxLength: 2,
+    minLength: 2,
+    example: 'US',
+  })
+  countryCode!: string;
+
+  @IsString({
+    isDate: { format: 'date-time' },
+    name: 'timestamp',
+  })
+  timestamp!: string;
+}
+
+@Controller({ path: 'test', version: '1' })
+export class TestController {
+  @Get()
+  async test(@TypedHeaders() headers: TestHeaders): Promise<string> {
+    return headers.countryCode;
+  }
+}
+```
+
 ## Other
 
 Bootstrapped with: [create-ts-lib-gh](https://github.com/glebbash/create-ts-lib-gh)

src/decorators/typed-headers.decorator.spec.ts

@@ -2,12 +2,10 @@ import { Controller, Get, INestApplication } from '@nestjs/common';
 import { Test } from '@nestjs/testing';
 import request from 'supertest';
 
-import { IsString } from './is-string';
-import { TypedHeaders } from './typed-headers.decorator';
+import { IsString, TypedHeaders } from '../nestjs-swagger-dto';
 
 export class TestHeaders {
   @IsString({
-    description: '[ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)',
     name: 'country-code',
     maxLength: 2,
     minLength: 2,
@@ -17,8 +15,6 @@ export class TestHeaders {
 
   @IsString({
     isDate: { format: 'date-time' },
-    example: '2011-12-01T00:00:00.000Z',
-    description: '[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)',
     name: 'timestamp',
   })
   timestamp!: string;

src/nestjs-swagger-dto.ts

@@ -12,3 +12,4 @@ export * from './decorators/is-nested';
 export * from './decorators/is-number';
 export * from './decorators/is-object';
 export * from './decorators/is-string';
+export * from './decorators/typed-headers.decorator';