Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

model

model: typeof Model

Methods

addRelatedModelsFiltersInReq

  • addRelatedModelsFiltersInReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco): Promise<void>

allowOnlyInBody

  • allowOnlyInBody(props: string[]): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    • props: string[]

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

applyIOPolicies

  • applyIOPolicies(res: Response<any, Record<string, any>>, element: any, obj: any, ioPolicies: IOPolicy[]): void

autoFetch

  • autoFetch(autoFetchConfigs: AutoFetchConfig[], send?: boolean): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => undefined | Promise<void>
  • Parameters

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => undefined | Promise<void>

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): undefined | Promise<void>
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns undefined | Promise<void>

checkExludeRolePolicy

  • checkExludeRolePolicy(modelAccessPolicy: ModelAccessPolicy, res: Response<any, Record<string, any>>): void

checkIncludeRolePolicy

  • checkIncludeRolePolicy(modelAccessPolicy: ModelAccessPolicy, res: Response<any, Record<string, any>>): void

checkModelAccessPolicy

  • checkModelAccessPolicy(operation: ModelOperation, element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

checkPublicPolicy

  • checkPublicPolicy(modelAccessPolicy: ModelAccessPolicy, res: Response<any, Record<string, any>>, element: null | Model): null | boolean

compareElementPropertyWithIds

  • compareElementPropertyWithIds(element: Model, property: string, ids: ObjectId[]): boolean

debug

  • debug(message: string): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    • message: string

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

delete

  • delete(options?: { ignoreSend: boolean }): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    • options: { ignoreSend: boolean } = ...
      • ignoreSend: boolean

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

deleteAfterDelete

  • deleteAfterDelete(result: any, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<any>

deleteElement

  • deleteElement(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

deleteElementId

  • deleteElementId(elementId: string | ObjectId, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<string | ObjectId>

extendGetAllQuery

  • extendGetAllQuery(query: Query, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<void>

extendGetOneQuery

  • extendGetOneQuery(query: Query, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, options?: GetOneOptions): Promise<void>

extendQueryBasedOnDecoPropAndValue

  • extendQueryBasedOnDecoPropAndValue(query: Query, deco: Deco, prop: string, filterValue: any): void

extendRequest

  • extendRequest(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, control: ModelOperation): Promise<void>

fetchModelIds

  • fetchModelIds(res: Response<any, Record<string, any>>, modelName: string, query: any): Promise<ObjectId[]>

filterObjectWithIOPolicy

  • filterObjectWithIOPolicy(obj: any, ioPolicy: IOPolicy): void

filterQueryFromDeco

filterQueryFromReq

  • filterQueryFromReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco): Promise<Query>

findDetectedModelRelations

findOriginalModelRelations

getAll

  • getAll(query?: null | Query, options?: ControllerGetAllOptions): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

getIOPolicies

  • getIOPolicies(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, operation: "input" | "output"): IOPolicy[]

getModelAccessPolicy

  • getModelAccessPolicy(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, operation: ModelOperation): null | ModelAccessPolicy

getModelDeco

  • getModelDeco(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): any

getOne

  • getOne(options?: ControllerGetOneOptions): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

getOneElement

  • getOneElement(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

getOneElementId

  • getOneElementId(elementId: string | ObjectId, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<string | ObjectId>

getPolicy

  • getPolicy(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Policy

limitQueryFromReq

  • limitQueryFromReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco): Promise<Query>

placeRelationalFiltersInReq

  • placeRelationalFiltersInReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, relatedQueriesSettings: RelatedModelFilterQueryConfig[], query: Query, deco?: Deco): Promise<void>

post

  • post(options?: ControllerPostOptions): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

postAfterInsert

  • postAfterInsert(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

postElement

  • postElement(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

postMany

  • postMany(options?: ControllerPostManyOptions): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

postManyQuantity

  • postManyQuantity(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, quantity?: number): Promise<number>

postOutput

  • postOutput(element: any, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<any>

postOutputList

  • postOutputList(elements: any, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<any>

preInput

  • preInput<T>(element: T, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<T>

prepareGetOneQuery

  • prepareGetOneQuery(elementId: string | ObjectId, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, options: GetOneOptions): Promise<Query>

prepareModelNotification

  • prepareModelNotification(res: Response<any, Record<string, any>>, element: Model): Promise<Model>

prepareQueryFromReq

  • prepareQueryFromReq(): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

processDownload

  • processDownload(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, element: Model): Promise<Model>
  • Process the query to find any downloadable files ?download=image : will try to download the file placed in the image property of the model (if any) By default, it will download the original file, except if the query has a preview= parameter ?preview=800:600 : will try to download the smaller file that has at least 800 px width and 600 px height ?preview=800 : will try to download the smaller file that has at least 800 px width ?preview=:600 : will try to download the smaller file that has at least 600 px height For properties of type "files", the query must also contain a "fileId" paramater, indicating which file to download from the array

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>
    • element: Model

    Returns Promise<Model>

put

  • put(options?: ControllerPutOptions): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

putAfterUpdate

  • putAfterUpdate(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

putElement

  • putElement(element: Model, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<Model>

putElementId

  • putElementId(elementId: string | ObjectId, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<string | ObjectId>

queryAfter

  • queryAfter(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco): Promise<Query>

queryBefore

  • queryBefore(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco): Promise<Query>

queryFromReq

  • queryFromReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, deco?: Deco, options?: QueryFromReqOptions): Promise<Query>

searchQueryFromReq

  • searchQueryFromReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco, searchQuery?: { $or: any[] }): Promise<Query>

sendLocals

  • sendLocals(key: string, output?: boolean | "list", model?: typeof Model): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => any
  • Parameters

    • key: string
    • output: boolean | "list" = false
    • Optional model: typeof Model

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => any

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): any
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns any

sendNotification

  • sendNotification(app: AppModel, email: string, subject: string, element: Model, keyValues: StringStringMap, contentPrefix: string, contentSuffix: string, template?: string, templateOverride: null | TemplateOverride): Promise<boolean>

sortQueryFromReq

  • sortQueryFromReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, query: Query, deco?: Deco): Promise<Query>

Static authenticateAndErrorOnlyIfNotPublic

  • authenticateAndErrorOnlyIfNotPublic(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void

Static deleteRoute

  • deleteRoute(): string

Static getAllRoute

  • getAllRoute(): string

Static getDecoFromConfigModel

Static getDecoFromSlug

  • getDecoFromSlug(appId: ObjectId, slug: string): Promise<Deco>

Static getOneRoute

  • getOneRoute(): string

Static multipartWrapper

  • multipartWrapper(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): any

Static placeDynamicConfigInRequest

  • placeDynamicConfigInRequest(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void

Static placeDynamicConfigInRequestWithSlug

  • placeDynamicConfigInRequestWithSlug(slug: string): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    • slug: string

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

Static postRoute

  • postRoute(): string

Static preventProperties

  • preventProperties(props: string[]): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
  • Parameters

    • props: string[]

    Returns (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

      • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction): void
      • Parameters

        • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        • res: Response<any, Record<string, any>>
        • next: NextFunction

        Returns void

Static putRoute

  • putRoute(): string

Static queryFromReq

  • queryFromReq(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, deco: Deco, options?: QueryFromReqOptions): Promise<Query>

Generated using TypeDoc