@nozbe/watermelondb/src/decorators/field/index.js

Build powerful React Native and React web apps that scale from hundreds to tens of thousands of records and remain fast

// @flow

import makeDecorator, { type Decorator } from '../../utils/common/makeDecorator'

import { type Value } from '../../QueryDescription'
import { type ColumnName } from '../../Schema'

import { ensureDecoratorUsedProperly } from '../common'

// Defines a model property
//
// Returns and sets values as-is, except that `undefined` and missing fields are normalized to `null`
// If you have a more specific propety, use the correct decorator (@boolean, @text, etc.)
//
// Pass the database column name as an argument
//
// Example:
//   @field('some_field') someField

const field: Decorator = makeDecorator(
  (columnName: ColumnName) => (target: Object, key: string, descriptor: Object) => {
    ensureDecoratorUsedProperly(columnName, target, key, descriptor)

    return {
      configurable: true,
      enumerable: true,
      get(): Value {
        // $FlowFixMe
        return this.asModel._getRaw(columnName)
      },
      set(value: any): void {
        // $FlowFixMe
        this.asModel._setRaw(columnName, value)
      },
    }
  },
)

export default field