TimezoneGetTimezoneByCoordinatesOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
accept |
Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to Supported Languages for details. |
options | Alternatively, use alias "o". Options available for types of information returned in the result. Possible values include: 'none', 'zoneInfo', 'transitions', 'all' |
time |
Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request. |
transitions |
Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. |
transitions |
Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
acceptLanguage
Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to Supported Languages for details.
acceptLanguage?: string
Property Value
string
options
Alternatively, use alias "o". Options available for types of information returned in the result. Possible values include: 'none', 'zoneInfo', 'transitions', 'all'
options?: TimezoneOptions
Property Value
timeStamp
Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request.
timeStamp?: Date
Property Value
Date
transitionsFrom
Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions.
transitionsFrom?: Date
Property Value
Date
transitionsYears
Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions.
transitionsYears?: number
Property Value
number
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
AbortSignalLike
Inherited From RequestOptionsBase.abortSignal
customHeaders
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
customHeaders?: [key: string]: string
Property Value
[key: string]: string
Inherited From RequestOptionsBase.customHeaders
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From RequestOptionsBase.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From RequestOptionsBase.onUploadProgress
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: number
Property Value
number
Inherited From RequestOptionsBase.timeout