Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetaService

A Class that defines the base Meta Model

param

Base Url for all relative http calls eg. 'meta/JobOrder'

param

Optional function to use to manipulate meta data returned

Hierarchy

  • MetaService

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

entity

entity: string

fields

fields: Field[] = []

http

http: AxiosInstance

label

label: string

memory

memory: any

Static BASIC

BASIC: string = "basic"

Static FULL

FULL: string = "full"

Static TRACK

TRACK: string = "track"

Accessors

endpoint

  • get endpoint(): string

Methods

_clean

  • _clean(name: any): string

extract

  • extract(fields: string[]): Field[]

get

  • get(requested: string[], layout?: string): Promise<Field[]>

  • Make http request to get meta data. Response data will be parsed, then the Promise will be resolved.

    Parameters

    • requested: string[]
    • Optional layout: string

    Returns Promise<Field[]>

getFull

missing

  • missing(fields: any): string[]

params

  • Will merge object into the entity's parameter to be sent in any http request.

    Parameters

    • object: any

      all additional parameters

    Returns MetaService

parse

  • parse(result: any): void

style

Static validate

  • validate(): Promise<boolean>

Object literals

parameters

parameters: object

fields

fields: string = "*"

meta

meta: string = "full"

Generated using TypeDoc