Class Point

constructor

• new Point(measurementName?: string): Point

• Create a new Point with specified a measurement name.

  Parameters

  • OptionalmeasurementName: string

    the measurement name

  Returns Point

fields

booleanField

• booleanField(name: string, value: any): Point

• Adds a boolean field.

  Parameters

  • name: string

    field name
  • value: any

    field value

  Returns Point

  this

floatField

• floatField(name: string, value: any): Point

• Adds a number field.

  Parameters

  • name: string

    field name
  • value: any

    field value

  Returns Point

  this

  Throws

  NaN/Infinity/-Infinity is supplied

intField

• intField(name: string, value: any): Point

• Adds an integer field.

  Parameters

  • name: string

    field name
  • value: any

    field value

  Returns Point

  this

  Throws

  NaN or out of int64 range value is supplied

measurement

• measurement(name: string): Point

• Sets point's measurement.

  Parameters

  • name: string

    measurement name

  Returns Point

  this

stringField

• stringField(name: string, value: any): Point

• Adds a string field.

  Parameters

  • name: string

    field name
  • value: any

    field value

  Returns Point

  this

tag

• tag(name: string, value: string): Point

• Adds a tag. The caller has to ensure that both name and value are not empty and do not end with backslash.

  Parameters

  • name: string

    tag name
  • value: string

    tag value

  Returns Point

  this

timestamp

• timestamp(value: undefined | string | number | Date): Point

• Sets point timestamp. Timestamp can be specified as a Date (preferred), number, string or an undefined value. An undefined value instructs to assign a local timestamp using the client's clock. An empty string can be used to let the server assign the timestamp. A number value represents time as a count of time units since epoch, the exact time unit then depends on the precision of the API that writes the point.

  Beware that the current time in nanoseconds can't precisely fit into a JS number, which can hold at most 2^53 integer number. Nanosecond precision numbers are thus supplied as a (base-10) string. An application can also use ES2020 BigInt to represent nanoseconds, BigInt's toString() returns the required high-precision string.

  Note that InfluxDB requires the timestamp to fit into int64 data type.

  Parameters

  • value: undefined | string | number | Date

    point time

  Returns Point

  this

toLineProtocol

• toLineProtocol(settings?: Partial<PointSettings>): undefined | string

• Creates an InfluxDB protocol line out of this instance.

  Parameters

  • Optionalsettings: Partial<PointSettings>

    settings control serialization of a point timestamp and can also add default tags, nanosecond timestamp precision is used when no settings or no settings.convertTime is supplied.

  Returns undefined | string

  an InfluxDB protocol line out of this instance

toString

• toString(): string

• Returns string

uintField

• uintField(name: string, value: any): Point

• Adds an unsigned integer field.

  Parameters

  • name: string

    field name
  • value: any

    field value

  Returns Point

  this

  Throws

  NaN out of range value is supplied