Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MeasurementService

This class allows for managing measurements.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • Creates a new measurement.

    example
    
 const mandantoryObject: Partial<IMeasurementCreate> = {
   sourceId: device.id,
   fragment: { series: { unit: '%', value: 51 } },
 };

 (async () => {
   const {data, res} = await measurementService.create(mandantoryObject);
 })();

    Parameters

    Returns Promise<IResult<IMeasurement>>

    Response wrapped in IResult

delete

  • Removes a measurement with given id.

    example
    
  const id: number = 1;

   (async () => {
     const {data, res} = await measurementService.delete(id);
  })();

    Parameters

    Returns Promise<IResult<null>>

    Response wrapped in IResult

detail

  • Gets the details of selected measurement.

    example
    
   const measurementId: number = 1;

   (async () => {
     const {data, res} = await measurementService.detail(measurementId);
  })();

    Parameters

    • entityOrId: string | number | IIdentified

      Entity or Id of the entity.

    Returns Promise<IResult<IMeasurement>>

    Response wrapped in IResult

list

  • Gets the list of measurements filtered by parameters.

    example
    
 const filter: object = {
    pageSize: 100,
    withTotalPages: true
  };

  (async () => {
    const {data, res, paging} = await measurementService.list(filter);
  })();

    Parameters

    • Default value filter: object = {}

      Object containing filters for querying measurements.

    Returns Promise<IResultList<IMeasurement>>

    Response wrapped in IResultList

list$

  • Gets a list as observable.

    example
    
  const list$ = measurementService.list$();
  list$.subscribe((data) => console.log(data));

    Parameters

    • Default value filter: object = {}

      Object containing filters for querying

    • Default value options: IObservableOptions = {}

      To configure the observable

    Returns ObservableList<IMeasurement>

    Data wrapped as ObservableList

listBySource$

  • List all events by a given source.

    example
    
  const listBySource$ = measurementService.listBySource$(11);
  listBySource$.subscribe((data) => console.log(data));

    Parameters

    • sourceOrId: string | number | IIdentified

      The source of the event.

    • Default value filter: object = {}

      Object containing filters for querying.

    • Default value options: IObservableOptions = {}

      To configure the observable.

    Returns ObservableList<IMeasurement>

    Data wrapped as ObservableList

listSeries

  • Gets the list of series in a measurement filtered by parameters.

    example
    
 const filter: object = {
   dateFrom: '2018-02-06T10:43:55.077Z',
   dateTo: '2018-02-06T10:50:55.077Z',
   source: device.id
 };

  (async () => {
    const {data, res} = await measurementService.listSeries(filter);
  })();

    Parameters

    Returns Promise<IResult<ISeries>>

    Response wrapped in IResult

Generated using TypeDoc