@agape/metadata

Example Decorator

Attaches an example value to the decorated class, property, method, or parameter.

API

@Example(  value: any)

Attaches an example value to the decorated class, property, method, or parameter.

@paramvalue: any

Attaches an example value to the decorated class, property, method, or parameter.

This decorator sets the example property on the associated MetadataDescriptor.

@Example({ name: 'Wireless Mouse', price: 29.99 })
class Product {
  name: string;
  price: number;
}

class Product {
  @Example('Wireless Mouse')
  name: string;

  @Example(29.99)
  price: number;
}

class ProductService {
  @Example([{ name: 'Wireless Mouse', price: 29.99 }])
  listProducts(): Product[] {
    return [];
  }
}

class ProductService {
  createProduct(
    @Example({ name: 'Wireless Mouse', price: 29.99 })
    product: Product
  ): void {
    // ...
  }
}