Skip to main content

goosetyped

Home > @pebula/goosetyped

goosetyped package#

Classes#

ClassDescription
DocumentArray
ObjectId

Functions#

FunctionDescription
addConnection(connectionId, connectionFactory, connectOptions)Registers a connection with GooseTyped to be used to compile Models registered under the same connection Id.
findModels()Return all Models / Resources registered in GooseTyped
getDiscriminatorKeyFor(modelClass)Returns the discriminator key for the provided Model / Resource. Only valid for discriminator implementation, thr base class will not yield a value.
getDiscriminatorKeysOf(modelClass)Returns the discriminator keys for the provided Model / Resource.
getEnum(cls, path)Returns the list of enums registered for a path in a Model / Resource.
getSchemaOf(modelClass)Returns the mongoose schema for the provided Model / Resource
GtColumn(metadata)
GtDeleteOneHook(stage)
GtDiscriminator()
GtDocument(metadata)
GtIndex(metadata)
GtIndex(metadata)
GtInitHook(stage)
GtInsertManyHook(stage)
GtInsertManyHook(stage)
GtLocalProp()
GtMethod()
GtModel()
GtModel(m1)
GtModel(m1, m2)
GtModel(m1, m2, m3)
GtModel(m1, m2, m3, m4)
GtModel(m1, m2, m3, m4, m5)
GtPlugin(metadata)
GtQuery(QH)
GtQuery(Q1, Q2)
GtQuery(Q1, Q2, Q3)
GtQuery(Q1, Q2, Q3, Q4)
GtRemoveHook(stage)
GtResource()
GtResource(m1)
GtResource(m1, m2)
GtResource(m1, m2, m3)
GtResource(m1, m2, m3, m4)
GtResource(m1, m2, m3, m4, m5)
GtSaveHook(stage)
GtSchemaType(metadata)
GtSkipVersioning()
GtSubDocument(metadata)
GtTimestampCreated()
GtTimestampUpdated()
GtToJSON(config)A decorator for toJSON with a prototype bound implementation for the transform function.Note that it recommended to avoid using a transform function (through schema options) or a transform method through this decorator and instead apply a transformation by overriding the toJSON. Call the super method and apply changed to the returned value, this is much better then using an out of context transformer. https://mongoosejs.com/docs/4.x/docs/guide.html\#toJSON
GtToObject(config)A decorator for toObject with a prototype bound implementation for the transform function.Note that it recommended to avoid using a transform function (through schema options) or a transform method through this decorator and instead apply a transformation by overriding the toObject. Call the super method and apply changed to the returned value, this is much better then using an out of context transformer. https://mongoosejs.com/docs/4.x/docs/guide.html\#toObject
GtUpdateOneHook(stage)
GtValidateHook(stage)
GtVersionKey()
mapSchemaType(runtimeType, metadata)

Interfaces#

InterfaceDescription
Ctor
GtBeforeCompileModelHandler
GtColumnMetadataArgs
GtCompoundIndexMetadataArgs
GtConnectOptions
GtDocumentMetadataArgs
GtIndexOptions
GtPluginMetadataArgs
GtSingleIndexMetadataArgs
GtSubDocumentMetadataArgs
Model
Resource
SubDocument
ValidatorMessageContext
ValidatorOpts

Type Aliases#

Type AliasDescription
ClassDecoratorOf
ColumnRequired
GtIndexSortOrder
GtSchemaTypeMetadataArgs
MethodDecoratorOf
PropertyDecoratorOf
StaticMethodDecoratorOf
StripDocA type helper that strips away all members of the mongoose Document instance from the type
StripDoColumnsA type helper that strips away all members of the mongoose Document instance from the type as well as all methods.
Type
Validatorhttps://mongoosejs.com/docs/api.html\#schematype\_SchemaType-validate
ValidatorFn