Function: Accept()

Accept<ClassPrototype, DTOConstructor, Method>(...defs): MethodDecorator<ClassPrototype, Method>

Validate the arguments of each call of the method, in order, against the schemas given; the method then receives the validated values (defaults applied, the keys without schema removed). A DTO class validates its argument against its schema: the method receives a plain object, not an instance of the class. The arguments beyond the schemas given are passed unchecked. An async method is validated asynchronously (its call rejects on failure), another method synchronously.

Type Parameters

ClassPrototype

ClassPrototype

DTOConstructor

DTOConstructor extends typeof DTO

Method

Method

Parameters

defs

...(Schema | DTOConstructor)[]

The schemas of the arguments, by position: DTO classes or schemas (DTO.String()).

Returns

MethodDecorator<ClassPrototype, Method>

The method decorator; the decorated method cannot be reassigned.

Remarks

A missing argument is accepted unless its schema is required (MyDTO.required(), DTO.String().required()), whether it is omitted or passed as undefined (its default then applied).

Throws

From a call, when an argument does not match its schema (its cause is the InvalidValueException of the validation).

Example

import {Component, DTO} from 'lakutata'
import {Accept, Expect} from 'lakutata/decorator/dto'

class TransferDTO extends DTO {
    @Expect(DTO.String().required())
    public to!: string

    @Expect(DTO.Number().positive().required())
    public amount!: number
}

class Bank extends Component {
    //The transfer is required, the note optional
    @Accept(TransferDTO.required(), DTO.String().max(140).optional())
    public async transfer(transfer: TransferDTO, note?: string): Promise<void> {
        console.log(`${transfer.amount} to ${transfer.to}`, note)
    }
}