Skip to main content

lightyear.modelconnector

Home > @runlightyear/lightyear > ModelConnector

ModelConnector class

Signature:
declare abstract class ModelConnector<ModelObjectData extends {
[key: string]: unknown;
} = any, ModelExternalData extends {
[key: string]: unknown;
} = any, ModelExternal = unknown, ModelListResponse = unknown>

Constructors

ConstructorModifiersDescription
(constructor)(props)Constructs a new instance of the ModelConnector class

Properties

PropertyModifiersTypeDescription
collectionNamestring
connectorAuthConnector
modelNamestring

Methods

MethodModifiersDescription
createBatch(props)
deleteBatch(props)
getNoun()
getPluralNoun()
list(props)
mapExternalToObject(external)
mapObjectDataToExternalData(data)
sync(syncId, direction)
updateBatch(props)
validateListResponse(response)