Class: Range
Range represents a set of integer values, used to match fields of a calendar time in StructuredCalendarSpec. If end < start, then end is interpreted as equal to start. This means you can use a Range with start set to a value, and end and step unset (defaulting to 0) to represent a single value.
Properties
end
end:
number
End of range (inclusive).
start
start:
number
Start of range (inclusive).
step
step:
number
Step (optional, default 1).
Methods
toJSON()
toJSON():
object
Converts this Range to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):Range&$Properties
Creates a new Range instance using the specified properties.
Parameters
properties?
Properties to set
Returns
Range & $Properties
Range instance
Call Signature
staticcreate(properties?):Range
Creates a new Range instance using the specified properties.
Parameters
properties?
Properties to set
Returns
Range
Range instance
decode()
staticdecode(reader,length?):Range&$Properties
Decodes a Range message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
Range & $Properties
Range
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):Range&$Properties
Decodes a Range message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
Range & $Properties
Range
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified Range message. Does not implicitly temporal.api.schedule.v1.Range.verify|verify messages.
Parameters
message
Range message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified Range message, length delimited. Does not implicitly temporal.api.schedule.v1.Range.verify|verify messages.
Parameters
message
Range message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):Range
Creates a Range message from a plain object. Also converts values to their respective internal types.
Parameters
object
{[k: string]: any; }
Plain object
Returns
Range
Range
toObject()
statictoObject(message,options?):object
Creates a plain object from a Range message. Also converts values to other types if specified.
Parameters
message
Range
Range
options?
IConversionOptions
Conversion options
Returns
object
Plain object