Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Component

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional archived

archived: null | Date

Readonly backObjects

backObjects: Set<Entity> = ...

Optional body

body: string

Optional compiled

compiled: string

create

create: (options?: CreateOptions) => Promise<Component> = ...

Type declaration

    • (options?: CreateOptions): Promise<Component>

    • Parameters

      • Optional options: CreateOptions

      Returns Promise<Component>

Optional description

description: string

Optional featureImage

featureImage: null | MerchiFile

Optional id

id: number

Optional images

images: MerchiFile[]

Optional isClassBased

isClassBased: boolean

isDirty

isDirty: boolean = false

key

key: string = ...

merchi

merchi: Merchi

Optional name

name: string

propertiesMap

propertiesMap: Map<string, PropertyInfo>

Optional tags

tags: ComponentTag[]

Static merchi

merchi: Merchi

Methods

cleanDirty

  • cleanDirty(): void

createFactory

  • createFactory(__namedParameters: Object): (options?: CreateOptions) => Promise<this>

  • Parameters

    • __namedParameters: Object

    Returns (options?: CreateOptions) => Promise<this>

      • (options?: CreateOptions): Promise<this>

      • Parameters

        • Optional options: CreateOptions

        Returns Promise<this>

delete

  • delete(options?: DeleteOptions): Promise<this>

fromJson

  • fromJson(json: any, options?: FromJsonOptions): this

getPrimaryKeyValue

  • getPrimaryKeyValue(): any

recover

  • recover(options?: SaveOptions): Promise<this>

save

  • save(options?: SaveOptions): Promise<this>

toFormData

  • toFormData(options?: SerialiseOptions, fileIndex?: Counter): FormData

toJson

  • toJson(): any

updateOrder

  • updateOrder(property: string): void

Static get

  • get<T>(key: string | number, options?: GetOptions): Promise<InstanceType<T>>

  • Type parameters

    Parameters

    • key: string | number
    • Optional options: GetOptions

    Returns Promise<InstanceType<T>>

Static list

  • list<T>(options?: ListOptions): Promise<ListResponse<InstanceType<T>>>

Generated using TypeDoc