Options
All
  • Public
  • Public/Protected
  • All
Menu

Module values/public-api

Index

Interfaces

Type Aliases

Functions

Type Aliases

CurrentValues

CurrentValues<T>: Record<string, ValuesTypeFrom<T> | [string, ValuesTypeFrom<T>]>

마지막(최신) 값 구조

Type Parameters

  • T

PeriodValues

PeriodValues<T>: Record<string, TimedValueObject<ValuesTypeFrom<T>>[] | TimedValueArray<ValuesTypeFrom<T>>[]>

누적 값 구조

Type Parameters

  • T

SummaryCondition

SummaryCondition<T>: Record<T, { methods: SummaryMethod[]; paths: T[]; positions: { methods: SummaryMethod[]; path: string }; slots: Record<T, TimedValueArray<any>> }>

누적 요약 값 생성 조건 구조

Type Parameters

  • T extends string

SummaryMethod

SummaryMethod: "sum" | "avg" | "min" | "max" | "count"

자원 값 요약 방식

TimedValueArray

TimedValueArray<T>: [string, T]

시계열 값 배열 구조체

Type Parameters

  • T

ValuesLogicalType

ValuesLogicalType: "abstract" | "unknown" | "json" | "json2string" | "json2numeric"

자원 운영 값 추상 유형 문자열

ValuesPhysicalType

ValuesPhysicalType: "string" | "numeric" | "numeric2string" | "numeric2buffer" | "buffer"

자원 운영 값 물리 유형 문자열

ValuesType

ValuesType: ValuesLogicalType | ValuesPhysicalType

자원 운영 값 유형 문자열

ValuesTypeFrom

ValuesTypeFrom<T>: T extends string ? T extends "numeric" ? number : string : T

값 유형 문자열로 부터 유형 반환

description
  • numeric => number
  • string => string
  • buffer => string

Type Parameters

  • T

Functions

getSummaryCondition

  • 요약 경로로 부터 요약 조건 반환

    example
    getSummaryCondition(
     [
         'a=sum',
         'a=avg',
         'b=min',
         'c=max',
         'd'
     ],
     'avg'
    );

     {
       paths: [
           'a',
           'b',
           'c',
           'd'
       ],
       methods: [
           'sum',
           'avg',
           'min',
           'max'
       ]
       slots: {
           'a=sum': [],
           'a=avg': [],
           'b=min': [],
           'c=max': [],
           'd': []
       },
       positions: {
           a: [
               {
                   path: 'a=avg',
                   method: 'avg'
               },
               {
                   path: 'a=sum',
                   method: 'sum'
               }
           ],
           b: [
               {
                   path: 'b=min',
                   method: 'min'
               }
           ],
           c: [
               {
                   path: 'c=max',
                   method: 'max'
               }
           ],
           d: [
               {
                   path: 'd',
                   method: 'avg'
               }
           ]
       }
    }
    see

    http://imrbiz.co.kr/documents/common-rest-apis/structures/values/values-periods.html

    Type Parameters

    • T extends string

    Parameters

    • summaryPaths: T[]

      경로와, 요약 방식이 합쳐진 요약 경로 배열

    • Optional bodyMethod: SummaryMethod

      본문에서 전달 받은 요약 방식

    • serverMethod: SummaryMethod = 'avg'

      기본 요약 방식

    Returns SummaryCondition<T>

toValuesPhysicalType

  • 논리 유형을 물리 유형으로 변경

    description

    numeric, string 외 모두 buffer 반환

    Parameters

    Returns ValuesPhysicalType

Generated using TypeDoc