base_Root_Module_rq.md

@onzag/itemize / Modules / base/Root/Module/rq

Module: base/Root/Module/rq

Contains all the RQ functions that are used and generated for and within the module, refer to this file for the RQ generation side of things

Table of contents

Functions

• getRQDefinitionForModule
• getRQSchemaForModule

Functions

getRQDefinitionForModule

▸ getRQDefinitionForModule(mod, options): RQField

Provides the fields definition for the module itself, and for all items inside the module which extend these fields, modules by default contain called base properties, which every element has

Parameters

Name	Type	Description
mod	default	the module in question
options	Object	-
options.excludeBase	boolean	whether to exclude the base properties, like created_at, etc..
options.onlyTextFilters	boolean	-
options.optionalForm	boolean	makes all the parameters optional, that is nullable
options.retrievalMode	boolean	whether it is in retrieval mode

Returns

RQField

all the fields definition for the module

Defined in

base/Root/Module/rq.ts:39

---

getRQSchemaForModule

▸ getRQSchemaForModule(mod, resolvers?): RQRootSchema

Provides the fields definition for the module itself, and for all items inside the module which extend these fields, modules by default contain called base properties, which every element has

Parameters

Name	Type	Description
mod	default	the module in question
resolvers?	IRQResolversType	-

Returns

RQRootSchema

all the fields definition for the module

Defined in

base/Root/Module/rq.ts:111