DtObj React Native Reference Documentation

DtObj

Current Version: 11.6.1

Chilkat.DtObj

Represent a date/time as simple editable fields.

Chilkat.DtObj is a lightweight date/time value object used by Chilkat methods that need to pass or return individual date and time fields. It stores values such as year, month, day, hour, minute, and second, along with a flag indicating whether the value represents UTC or local time. It also provides a compact serialization format for saving and restoring the date/time value.

Simple date fields

Store and edit the year, month, day, hour, minute, and second as individual properties.

UTC or local time

Use the UTC flag to indicate whether the stored fields represent UTC or local time.

Struct tm compatibility

Use alternate month and year properties when working with struct tm-style date/time conventions.

Serialize and restore

Save and restore the object using Chilkat's compact internal serialized date/time representation.

Used by other classes

Pass DtObj values to Chilkat methods that require explicit date/time fields or return date/time information.

Small and focused

Use this class as a simple container rather than a full date/time calculation or timezone-conversion engine.

Common pattern: Create or receive a DtObj, set or read the individual date/time fields, check whether the value is UTC or local time, and pass the object to another Chilkat method. Use serialization only when the date/time value needs to be saved and restored in Chilkat's compact internal format.

For an extended overview, see DtObj Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, DtObj } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const dtObj = new DtObj()
// ... the native object is released when `dtObj` is garbage collected, or now with dtObj.dispose()

new DtObj()

Creates the underlying native Chilkat object. DtObj is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  dtObj.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // DtObj.someMethod(...): <reason>
  console.log(dtObj.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await dtObj.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // DtObj.someMethodAsync: <reason>
}

Properties

Day

// read/write
day: number

The day of the month. The valid values for this member are 1 through 31.

DtObj React Native Reference Documentation

DtObj

Current Version: 11.6.1

Represent a date/time as simple editable fields.

Simple date fields

UTC or local time

Struct tm compatibility

Serialize and restore

Used by other classes

Small and focused

Object Creation

Errors

Properties

Day

DebugLogFilePath

Hour

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Minute

Month

Second

StructTmMonth

StructTmYear

Utc

VerboseLogging

Version

Year

Methods

DeSerialize

Serialize