View Source XtbClient.Messages.Period (XtbClient v0.1.1)

Specifies time interval - counted in multiples of minute.

Link to this section Summary

Functions

Formats period given as Period to number of minutes.

Parses value given as number of minutes to Period atom type.

Link to this section Types

@type minute_period() :: 1 | 5 | 15 | 30 | 60 | 240 | 1440 | 10080 | 43200
@type t() :: :m1 | :m5 | :m15 | :m30 | :h1 | :h4 | :d1 | :w1 | :mn1

Link to this section Functions

@spec format(t()) :: minute_period()

Formats period given as Period to number of minutes.

@spec parse(minute_period()) :: t()

Parses value given as number of minutes to Period atom type.