Class ReverseSingleReference<FormatParams>

Type parameters

FormatParams

Hierarchy

Field<never, string[]>
- ReverseSingleReference

Index

Constructors

constructor

Properties

Constructors

constructor

new ReverseSingleReference(app: App, collection: Collection, name: string, required: boolean, display_hints: any): ReverseSingleReference

Inherited from HybridField.constructor
- Defined in src/chip-types/field.ts:101
Creates a new instance of a field

Parameters
- app: App
- collection: Collection
- name: string
- required: boolean
- display_hints: any
Returns ReverseSingleReference

Properties

collection

collection: Collection

The collection this field is attached to

display_hints

display_hints: any

The display hints specified for this field

get_referencing_field

get_referencing_field: () => Field

Type declaration

- (): Field
- Returns Field

handles_large_data

handles_large_data: boolean = false

Whether or not the field handles large data

todo:: see if there's any viability in storing this

name

name: string

the name of the field

required

required: boolean

Whether or not this field should always have a value. Creating a resource with a value missing for a required field will throw an error

Methods

decode

decode(_: Context, storage_value: Depromisify<ReturnType<this["encode"]>>, __: string[], ___: FormatParams): Promise<string[] | null>

Inherited from Field.decode
- Defined in src/chip-types/field.ts:229
Reverse to the Field.encode function. Takes what's inside the database and returns the value in a given format

Parameters
- _: Context
- storage_value: Depromisify<ReturnType<this["encode"]>>
- __: string[]
- ___: FormatParams
Returns Promise<string[] | null>

encode

encode(_: Context, value: never | null, __?: InputType): Promise<any>

Inherited from Field.encode
- Defined in src/chip-types/field.ts:220
Decides how to store the given value in the database, based on the context and previous value of the field

Parameters
- _: Context
- value: never | null
- Optional __: InputType
Returns Promise<any>

filterToQuery

filterToQuery(context: Context, field_filter: any): Promise<{ $eq: any } | { $in: string[] }>

Overrides Field.filterToQuery
- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:195
Parameters
- context: Context
- field_filter: any
Returns Promise<{ $eq: any } | { $in: string[] }>

fullTextSearchEnabled

fullTextSearchEnabled(): Promise<boolean>

Inherited from HybridField.fullTextSearchEnabled
- Defined in src/chip-types/field.ts:244
Whether or not the db should create a fulltext index on this field

Returns Promise<boolean>

getAggregationStages

getAggregationStages(context: Context, query_params: { filter?: undefined | {} }): Promise<QueryStage[]>

Inherited from HybridField.getAggregationStages
- Defined in src/chip-types/field.ts:163
Creates parts of a Mongo Pipieline that will be used to filter the items when listing items of a collection

Parameters
- context: Context
- query_params: { filter?: undefined | {} }
  - Optional filter?: undefined | {}
Returns Promise<QueryStage[]>

getAttachmentLoader

getAttachmentLoader(context: Context, _: boolean, attachment_params: ConstructorParameters<typeof ReferenceToCollection>[2]): ReferenceToCollection

Overrides HybridField.getAttachmentLoader
- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:182
Parameters
- context: Context
- _: boolean
- attachment_params: ConstructorParameters<typeof ReferenceToCollection>[2]
Returns ReferenceToCollection

getCacheKey

getCacheKey(): string

- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:25
Returns string

getDefaultValue

getDefaultValue(): Depromisify<ReturnType<this["decode"]>> | null

Inherited from HybridField.getDefaultValue
- Defined in src/chip-types/field.ts:252
The default value that will be assigned to the field if no value is given

Returns Depromisify<ReturnType<this["decode"]>> | null

getReferencingCollection

getReferencingCollection(): Collection

- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:21
Returns Collection

getSpecification

getSpecification(): { display_hints: any; name: string; type: string }

Inherited from HybridField.getSpecification
- Defined in src/chip-types/field.ts:146
Return a summary of this field

Returns { display_hints: any; name: string; type: string }
- display_hints: any
- name: string
- type: string

getTypeName

getTypeName(): string

Overrides HybridField.getTypeName
- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:8
Returns string

getValuePath

getValuePath(): Promise<string>

Inherited from HybridField.getValuePath
- Defined in src/chip-types/field.ts:207
Value path is where inside a single record should the DB look for the field's value when filtering resources. Some fields use complex objects for storage and overwrite this method, and thanks to that they don't have to reimplement Field.getAggregationStages

Returns Promise<string>

hasDefaultValue

hasDefaultValue(): boolean

Inherited from HybridField.hasDefaultValue
- Defined in src/chip-types/field.ts:249
Whether or not a field has a default value - that is, a value given to the field if no value is provided

Returns boolean

hasIndex

hasIndex(): boolean | "text" | {}

Inherited from HybridField.hasIndex
- Defined in src/chip-types/field.ts:155
Whether or not this field should have a dedicated index in the database

Returns boolean | "text" | {}

init

init(app: App): Promise<void>

Overrides HybridField.init
- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:33
Parameters
- app: App
Returns Promise<void>

isOldValueSensitive

isOldValueSensitive(_: ActionName): boolean

Inherited from HybridField.isOldValueSensitive
- Defined in src/chip-types/field.ts:257
Whether or not any of the methods of the field depend on the previous value of the field

Parameters
- _: ActionName
Returns boolean

isProperValue

isProperValue(context: Context, _: any): Promise<{ reason?: undefined | string; valid: boolean }>

Overrides Field.isProperValue
- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:11
Parameters
- context: Context
- _: any
Returns Promise<{ reason?: undefined | string; valid: boolean }>

setParams

setParams(params: { referencing_field: () => Field }): void

Overrides Field.setParams
- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:17
Parameters
- params: { referencing_field: () => Field }
  - referencing_field: () => Field
    - - (): Field
      - Returns Field
Returns void

updateCache

updateCache(resource_ids?: string[]): Promise<void>

- Defined in src/app/base-chips/field-types/reverse-single-reference.ts:136
Parameters
- Optional resource_ids: string[]
Returns Promise<void>

Static fromDefinition

fromDefinition<T>(app: App, collection: Collection, definition: { display_hints?: any; name: string; params?: Parameters<InstanceType<FieldClass>["setParams"]>[0]; required?: undefined | false | true; type: T }): Field<any, any, any>

Inherited from HybridField.fromDefinition
- Defined in src/chip-types/field.ts:119
Create a new instance of Field based on the definition. **It's recommended to use FieldDefinitionHelper instead

Type parameters
- T: FieldClass
Parameters
- app: App
- collection: Collection
- definition: { display_hints?: any; name: string; params?: Parameters<InstanceType<FieldClass>["setParams"]>[0]; required?: undefined | false | true; type: T }
  - Optional display_hints?: any
  - name: string
  - Optional params?: Parameters<InstanceType<FieldClass>["setParams"]>[0]
  - Optional required?: undefined | false | true
  - type: T
Returns Field<any, any, any>

Static invalid

invalid(reason: string): ValidationResult

Inherited from HybridField.invalid
- Defined in src/chip-types/field.ts:267
Used to signal a negative decition from within Field.isProperValue.

Parameters
- reason: string
Returns ValidationResult

Static valid

valid(): ValidationResult

Inherited from HybridField.valid
- Defined in src/chip-types/field.ts:262
Used to signal a positive decision from within Field.isProperValue.

Returns ValidationResult

Generated using TypeDoc