json-api-nestjs/src/lib/modules/mixin/types/binding.types.d.ts

JsonApi Plugin for NestJs

import { PipeTransform, RequestMethod } from '@nestjs/common';
import { Type } from '@nestjs/common/interfaces';
import { PipeFabric } from './module.types';
import { JsonBaseController } from '../controller/json-base.controller';
import { ObjectLiteral } from '../../../types';
export type MethodName = 'getAll' | 'getOne' | 'postOne' | 'patchOne' | 'getRelationship' | 'deleteOne' | 'deleteRelationship' | 'postRelationship' | 'patchRelationship';
type MapNameToTypeMethod = {
    getAll: RequestMethod.GET;
    getOne: RequestMethod.GET;
    patchOne: RequestMethod.PATCH;
    patchRelationship: RequestMethod.PATCH;
    postOne: RequestMethod.POST;
    postRelationship: RequestMethod.POST;
    deleteOne: RequestMethod.DELETE;
    deleteRelationship: RequestMethod.DELETE;
    getRelationship: RequestMethod.GET;
};
export interface Binding<T extends MethodName> {
    path: string;
    method: MapNameToTypeMethod[T];
    name: T;
    implementation: JsonBaseController<ObjectLiteral>[T];
    parameters: {
        decorator: (property?: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]) => ParameterDecorator;
        property?: string;
        mixins: PipeFabric[];
    }[];
}
export type BindingsConfig = {
    [Key in MethodName]: Binding<Key>;
};
export {};