@chilkat/react-native 11.6.1

package/src/specs/Tar.nitro.ts

@@ -0,0 +1,804 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+
+/**
+ * Create, list, verify, filter, and extract TAR archives and compressed TAR formats.
+ *
+ * `Tar` creates, verifies, lists, and extracts TAR archives,
+ * including compressed TAR formats such as `.tar.gz`,
+ * `.tgz`, `.tar.bz2`, and `.tar.Z`. It
+ * supports adding individual files and directory trees, controlling archive
+ * paths, preserving or overriding file permissions, filtering included or
+ * extracted files, extracting from memory, extracting selected entries to
+ * memory or `BinData`, producing XML listings, and creating Debian
+ * `.deb` package archives from control and data tarballs.
+ *
+ * **Create TAR archives**
+ *
+ * Add files or directory trees and write standard TAR output, with control
+ * over archive paths, directory handling, and write format.
+ *
+ * **Compressed TAR formats**
+ *
+ * Work with common compressed archive forms such as `.tar.gz`,
+ * `.tgz`, `.tar.bz2`, and `.tar.Z`.
+ *
+ * **List and verify contents**
+ *
+ * Inspect archive entries, verify archive structure, and produce XML
+ * listings for display, logging, or programmatic processing.
+ *
+ * **Selective extraction**
+ *
+ * Extract entire archives or selected entries, including workflows that
+ * extract matching files directly to memory or `BinData`.
+ *
+ * **Filters and paths**
+ *
+ * Include or exclude files using filters, control relative paths in the
+ * archive, and manage how entries are restored during extraction.
+ *
+ * **Permissions and packages**
+ *
+ * Preserve or override UNIX-style permissions and create Debian
+ * `.deb` package archives from control and data tarballs.
+ *
+ * **Common pattern:**
+ * Use `Tar` when the data is a TAR archive or a compressed TAR
+ * archive. Configure the archive paths, filters, permissions, and compression
+ * format, then create, list, verify, or extract the archive as needed. Use
+ * `Chilkat.Zip` for ZIP archives, `Chilkat.Gzip` for a
+ * single GZIP stream, and `Chilkat.Compression` for raw compression
+ * operations.
+ *
+ * For an extended overview, see
+ * [Tar Class Overview](https://www.chilkatsoft.com/tar_class_overview.asp).
+ *
+ * Each `Tar` instance owns a native Chilkat object. It is released when the JavaScript object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new Tar()`.
+ *
+ * Methods that can take a while (network, files, compression, key generation) also have an
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
+ * rendering. While such a call is pending, every other call on this object throws, except
+ * {@link Tar.abort} and assigning {@link Tar.onPercentDone} / {@link Tar.onProgressInfo}.
+ */
+export interface Tar extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * Controls whether extraction methods also capture an XML inventory of the archive. When set to
+   * `true`, methods such as `Untar`, `UntarGz`, `UntarBz2`, and `UntarZ` store the listing in
+   * {@link Tar.xmlListing}. The XML has the same structure as the string returned by {@link
+   * Tar.listXml}. The default is `false`.
+   *
+   * **Inspect without extracting:** Set `CaptureXmlListing` and {@link Tar.suppressOutput} to
+   * `true` before an untar operation to scan the archive and obtain its XML listing without writing
+   * archive entries to disk.
+   */
+  captureXmlListing: boolean
+
+  /**
+   * Specifies the character encoding used to decode filenames stored in a TAR archive during
+   * extraction. The default is `utf-8`, which is normally appropriate for modern archives.
+   *
+   * This property affects archive entry names only. It does not convert or otherwise alter the
+   * contents of extracted files. TAR archives written by the `WriteTar*` methods store filenames as
+   * UTF-8.
+   *
+   * **Filename interoperability:** The original TAR header format does not always identify the
+   * character encoding of a filename. Change this property only when an older archive is known to
+   * use a different encoding.
+   */
+  charset: string
+
+  /**
+   * Specifies the UNIX permission bits written to the TAR header for directory entries created by
+   * the `WriteTar*` methods. The default is octal `0755`, which represents `rwxr-xr-x`.
+   *
+   * **Archive metadata:** This value records permissions in the archive. Whether the exact
+   * permissions are restored during extraction depends on the destination operating system,
+   * filesystem, process privileges, and local security policy.
+   */
+  dirMode: number
+
+  /**
+   * Specifies a path prefix to prepend to entries when a TAR archive is created. For example,
+   * setting this property to `subdir1` causes an entry such as `report.txt` to be stored as
+   * `subdir1/report.txt`.
+   *
+   * The prefix changes only the path stored in the archive; it does not rename or move the source
+   * file on disk.
+   *
+   * **AddFile2 exception:** {@link Tar.addFile2} explicitly supplies the complete path within the
+   * archive, so `DirPrefix` is not applied to files added by that method.
+   */
+  dirPrefix: string
+
+  /**
+   * Specifies the UNIX permission bits written to the TAR header for ordinary file entries created
+   * by the `WriteTar*` methods. The default is octal `0644`, which represents `rw-r--r--`.
+   *
+   * **Shell scripts:** Files recognized as shell scripts use {@link Tar.scriptFileMode} instead,
+   * allowing executable permissions to be recorded separately.
+   */
+  fileMode: number
+
+  /**
+   * Specifies the numeric group identifier (GID) written to TAR headers when an archive is created.
+   * The default value is `1000`.
+   *
+   * **Ownership metadata:** A stored GID is archive metadata. Restoring ownership may require
+   * elevated privileges and may be ignored or mapped differently on non-UNIX systems.
+   */
+  groupId: number
+
+  /**
+   * Specifies the group name written to TAR headers when an archive is created. By default, Chilkat
+   * uses the username of the account running the application.
+   *
+   * **Name versus numeric ID:** TAR headers can contain both a group name and the numeric {@link
+   * Tar.groupId}. Extraction tools and operating systems may give different precedence to these
+   * fields.
+   */
+  groupName: string
+
+  /**
+   * Specifies the approximate interval, in milliseconds, between `AbortCheck` event callbacks
+   * during supported long-running operations. The default is `0`, which disables periodic
+   * `AbortCheck` callbacks.
+   *
+   * **Cancellation is cooperative:** A callback can request that an operation stop, but the request
+   * is observed only when the running method reaches a cancellation check. Short operations may
+   * finish before a callback occurs.
+   */
+  heartbeatMs: number
+
+  /**
+   * Controls whether the patterns in {@link Tar.mustMatch} and {@link Tar.mustNotMatch} are matched
+   * case-sensitively. The default is `false`.
+   *
+   * **Cross-platform behavior:** Case sensitivity in the archive filter is independent of whether
+   * the local filesystem itself treats filenames as case-sensitive.
+   */
+  matchCaseSensitive: boolean
+
+  /**
+   * Specifies an inclusion pattern applied when creating or extracting TAR archives, including
+   * compressed TAR formats. A candidate path is included or extracted only when it matches this
+   * pattern. The default is an empty string, which permits all paths.
+   *
+   * The pattern may contain zero or more asterisks (`*`), where each asterisk matches zero or more
+   * characters. For example, `*.txt` selects paths ending in `.txt`. Case handling is controlled by
+   * {@link Tar.matchCaseSensitive}.
+   *
+   * **Combined filters:** If both `MustMatch` and {@link Tar.mustNotMatch} are set, a path must
+   * satisfy the inclusion pattern and must not satisfy the exclusion pattern.
+   */
+  mustMatch: string
+
+  /**
+   * Specifies an exclusion pattern applied when creating or extracting TAR archives, including
+   * compressed TAR formats. A candidate path that matches this pattern is skipped. The default is
+   * an empty string, which excludes nothing.
+   *
+   * The pattern may contain zero or more asterisks (`*`), where each asterisk matches zero or more
+   * characters. For example, `*.obj` skips paths ending in `.obj`. Case handling is controlled by
+   * {@link Tar.matchCaseSensitive}.
+   *
+   * **Exclusion takes effect after inclusion:** When both filters are set, matching {@link
+   * Tar.mustMatch} does not override a match in `MustNotMatch`.
+   */
+  mustNotMatch: string
+
+  /**
+   * Controls whether absolute archive paths are converted to relative paths during extraction. When
+   * `true`, a leading `/` or `\` is removed before the entry is written. The default is `true`.
+   *
+   * **Recommended security setting:** Keep this property enabled when extracting archives you did
+   * not create. Also extract untrusted archives into a dedicated directory and inspect their entry
+   * names before relying on the extracted content.
+   */
+  noAbsolutePaths: boolean
+
+  /**
+   * Returns the number of directory roots currently registered for archive creation by calls to
+   * {@link Tar.addDirRoot} and {@link Tar.addDirRoot2}. Individual files added with `AddFile` or
+   * `AddFile2` are not included in this count.
+   *
+   * Use zero-based indexes from `0` through `NumDirRoots - 1` with {@link Tar.getDirRoot}.
+   *
+   * This property is read-only.
+   */
+  readonly numDirRoots: number
+
+  /**
+   * Specifies the value reported by `PercentDone` when an eligible operation is 100% complete. The
+   * default is `100`. Increasing the scale allows finer-grained integer progress values; for
+   * example, a scale of `1000` allows `453` to represent 45.3%.
+   *
+   * The value is clamped to the range `10` through `100000`. This property is available only in
+   * environments that support event callbacks, and only methods for which measurable progress is
+   * available emit percentage updates.
+   *
+   * **Scale, not frequency:** A larger scale increases the numeric resolution of progress values
+   * but does not guarantee a callback for every possible value.
+   */
+  percentDoneScale: number
+
+  /**
+   * Specifies the UNIX permission bits written to TAR headers for shell-script files recognized by
+   * extensions such as `.sh`, `.csh`, `.bash`, and `.bsh`. The default is octal `0755`, which
+   * records executable permissions.
+   *
+   * **Other files:** Non-script files use {@link Tar.fileMode}; directories use {@link
+   * Tar.dirMode}.
+   */
+  scriptFileMode: number
+
+  /**
+   * Controls whether untar operations write extracted files and directories to the filesystem. When
+   * `true`, methods such as `Untar`, `UntarGz`, `UntarBz2`, and `UntarZ` scan the archive without
+   * producing extracted output. The default is `false`.
+   *
+   * **Archive inventory workflow:** Combine this property with {@link Tar.captureXmlListing} to
+   * obtain an XML listing without extracting the archive.
+   */
+  suppressOutput: boolean
+
+  /**
+   * **Deprecated.** Use {@link Tar.matchCaseSensitive} instead.
+   *
+   * Until this property is removed, reading or setting it has the same effect as reading or setting
+   * `MatchCaseSensitive`.
+   */
+  untarCaseSensitive: boolean
+
+  /**
+   * Controls whether untar methods add per-entry extraction details to `LastErrorText`,
+   * `LastErrorXml`, and `LastErrorHtml`. The default is `false`.
+   *
+   * **Diagnostic output is not necessarily an error:** When this property is enabled, the LastError
+   * properties can contain useful extraction trace information even after a successful operation.
+   */
+  untarDebugLog: boolean
+
+  /**
+   * Controls whether directory components from archive entry names are discarded during extraction.
+   * When `true`, each file is written directly into {@link Tar.untarFromDir} rather than recreating
+   * the archived directory tree. The default is `false`.
+   *
+   * **Filename collisions:** Different archive entries can have the same final filename after their
+   * directory paths are removed. Use this option only when flattening the archive is intentional
+   * and potential collisions are acceptable.
+   */
+  untarDiscardPaths: boolean
+
+  /**
+   * Specifies the destination directory for extraction. The default is `.`, meaning the current
+   * working directory of the calling process.
+   *
+   * When {@link Tar.untarDiscardPaths} is `false`, archived subdirectories are recreated beneath
+   * this directory. When it is `true`, extracted files are placed directly in this directory.
+   *
+   * **Safer extraction:** For untrusted archives, choose a new or otherwise isolated destination
+   * directory rather than extracting directly into an application or system directory.
+   */
+  untarFromDir: string
+
+  /**
+   * Limits the number of matching entries extracted by an untar operation. The default is `0`,
+   * which means no maximum.
+   *
+   * For example, set {@link Tar.mustMatch} to select a particular path and set `UntarMaxCount` to
+   * `1` to stop after the first matching entry is extracted.
+   *
+   * **Archive order matters:** When a limit is used, extraction stops after the configured number
+   * of matches in archive order.
+   */
+  untarMaxCount: number
+
+  /**
+   * Specifies the numeric user identifier (UID) written to TAR headers when an archive is created.
+   * The default value is `1000`.
+   *
+   * **Ownership metadata:** A stored UID does not by itself change the owner of a local source
+   * file. Restoring ownership during extraction may require elevated privileges and may not apply
+   * on non-UNIX systems.
+   */
+  userId: number
+
+  /**
+   * Specifies the user name written to TAR headers when an archive is created. By default, Chilkat
+   * uses the username of the account running the application.
+   *
+   * **Name versus numeric ID:** TAR headers can contain both a user name and the numeric {@link
+   * Tar.userId}. Their interpretation depends on the extracting tool and destination system.
+   */
+  userName: string
+
+  /**
+   * Specifies the TAR header format used by the `WriteTar*` methods. The default is `gnu`.
+   * Supported values are:
+   *
+   * ValueUse
+   *
+   * | `gnu` | | GNU TAR format and extensions. This is the Chilkat default and supports archive
+   * metadata beyond classic ustar limits. |
+   *
+   * | `pax` | | POSIX pax extended format. It is designed to represent long names and additional
+   * metadata through extensible records. |
+   *
+   * | `ustar` | | POSIX ustar format. It is broadly interoperable but has stricter limits on path
+   * lengths and metadata fields. |
+   *
+   * **Choosing a format:** Use `ustar` when compatibility with simple TAR readers is the priority
+   * and the archive fits its limits. Use `pax` for portable extended metadata, or retain `gnu` when
+   * GNU TAR compatibility is expected.
+   */
+  writeFormat: string
+
+  /**
+   * Contains the XML listing captured by the most recent untar operation for which {@link
+   * Tar.captureXmlListing} was `true`. The XML structure is the same as the output from {@link
+   * Tar.listXml}.
+   *
+   * **Read after the operation:** Use the untar method's return value to confirm that the archive
+   * was processed successfully before consuming this property.
+   */
+  xmlListing: string
+
+  // ---- Methods ----
+
+  /**
+   * Adds the directory tree at `dirPath` to the set of sources used by the next `WriteTar*`
+   * operation. Call this method multiple times to include multiple directory trees in one archive.
+   *
+   * Use {@link Tar.addDirRoot2} when the tree should appear beneath an explicit prefix inside the
+   * archive.
+   *
+   * **Queued archive sources:** Directory roots and files are retained by the object until {@link
+   * Tar.clearDirRootsAndFiles} is called.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  addDirRoot(dirPath: string): void
+
+  /**
+   * Adds the local file at `path` to the set of sources used by the next `WriteTar*` operation.
+   * Call `AddFile`, `AddFile2`, and the directory-root methods as needed before writing a single
+   * archive.
+   *
+   * Use {@link Tar.addFile2} when the path stored inside the TAR must be specified independently of
+   * the source file path.
+   *
+   * **Queued archive sources:** Added files and directory roots remain associated with the object
+   * until {@link Tar.clearDirRootsAndFiles} is called.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  addFile(path: string): void
+
+  /**
+   * Returns a directory root previously added with {@link Tar.addDirRoot} or {@link
+   * Tar.addDirRoot2}. `index` is a zero-based index.
+   *
+   * Valid indexes range from `0` through `
2 - 1`. For example, after two roots are added,
+   * `GetDirRoot(0)` returns the first and `GetDirRoot(1)` returns the second.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  getDirRoot(index: number): string
+
+  /**
+   * Scans the uncompressed TAR archive at `tarPath` and returns an XML description of its files,
+   * directories, and archive metadata. The archive is not extracted.
+   *
+   * **Compressed tarballs:** For a compressed TAR archive, an untar method can capture the same
+   * listing format by setting {@link Tar.captureXmlListing}. Set {@link Tar.suppressOutput} as well
+   * when no files should be written.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.listXmlAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  listXml(tarPath: string): string
+
+  /**
+   * Asynchronous form of {@link Tar.listXml}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  listXmlAsync(tarPath: string): Promise<string>
+
+  /**
+   * Extracts the uncompressed TAR archive at `tarPath` into the directory specified by {@link
+   * Tar.untarFromDir}. Archived directory trees are recreated unless {@link Tar.untarDiscardPaths}
+   * is `true`.
+   *
+   * Returns the number of files and directories extracted, or `-1` if the operation fails.
+   * Extraction is also affected by the matching, path-safety, count-limit, listing, and
+   * output-suppression properties of this object.
+   *
+   * **TAR is a container format:** An ordinary `.tar` archive is not compressed. Use `UntarGz`,
+   * `UntarBz2`, or `UntarZ` for the corresponding compressed tarball formats.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.untarAsync}.
+   */
+  untar(tarPath: string): number
+
+  /**
+   * Asynchronous form of {@link Tar.untar}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   */
+  untarAsync(tarPath: string): Promise<number>
+
+  /**
+   * Decompresses and extracts the `.tar.bz2` archive at `tarPath` into {@link Tar.untarFromDir}.
+   * This format is also commonly named `.tbz`, `.tbz2`, or `.tb2`.
+   *
+   * Returns `true` on success and `false` on failure. The same extraction filters, path controls,
+   * listing options, and output settings used by {@link Tar.untar} also apply.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.untarBz2Async}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarBz2(tarPath: string): void
+
+  /**
+   * Asynchronous form of {@link Tar.untarBz2}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarBz2Async(tarPath: string): Promise<void>
+
+  /**
+   * Decompresses and extracts the `.tar.gz` archive at `tarPath` into {@link Tar.untarFromDir}. The
+   * `.tgz` extension is a common short form for the same gzip-compressed TAR structure.
+   *
+   * Returns `true` on success and `false` on failure. The same extraction filters, path controls,
+   * listing options, and output settings used by {@link Tar.untar} also apply.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.untarGzAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarGz(tarPath: string): void
+
+  /**
+   * Asynchronous form of {@link Tar.untarGz}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarGzAsync(tarPath: string): Promise<void>
+
+  /**
+   * Decompresses and extracts the `.tar.Z` archive at `tarPath` into {@link Tar.untarFromDir}. The
+   * `.Z` suffix denotes the historical UNIX `compress` format; `.taz` is a common alternate
+   * extension.
+   *
+   * Returns `true` on success and `false` on failure. The same extraction filters, path controls,
+   * listing options, and output settings used by {@link Tar.untar} also apply.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.untarZAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarZ(tarPath: string): void
+
+  /**
+   * Asynchronous form of {@link Tar.untarZ}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarZAsync(tarPath: string): Promise<void>
+
+  /**
+   * Opens the uncompressed TAR archive at `tarPath` and scans its headers through the end of the
+   * archive. Returns `true` when the archive structure is accepted and no TAR-format errors are
+   * found; otherwise returns `false`.
+   *
+   * **What verification does not establish:** Structural verification does not prove that archived
+   * files are safe, trustworthy, or appropriate to extract. It is not malware scanning and does not
+   * authenticate the archive publisher.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.verifyTarAsync}.
+   */
+  verifyTar(tarPath: string): boolean
+
+  /**
+   * Asynchronous form of {@link Tar.verifyTar}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   */
+  verifyTarAsync(tarPath: string): Promise<boolean>
+
+  /**
+   * Creates an uncompressed TAR archive at `tarPath` from the files and directory trees previously
+   * added with `AddFile`, `AddFile2`, `AddDirRoot`, and `AddDirRoot2`. Archive paths, permissions,
+   * ownership metadata, filters, and header format are controlled by the corresponding properties.
+   *
+   * Returns `true` on success and `false` on failure.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.writeTarAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  writeTar(tarPath: string): void
+
+  /**
+   * Asynchronous form of {@link Tar.writeTar}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  writeTarAsync(tarPath: string): Promise<void>
+
+  /**
+   * Creates a bzip2-compressed TAR archive at `bz2Path` from the files and directory trees
+   * previously added to this object. Common filename extensions include `.tar.bz2`, `.tbz`,
+   * `.tbz2`, and `.tb2`.
+   *
+   * Returns `true` on success and `false` on failure.
+   *
+   * **Two-layer format:** The result is a TAR byte stream compressed with bzip2. TAR supplies the
+   * multi-file archive structure; bzip2 supplies compression.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.writeTarBz2Async}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  writeTarBz2(bz2Path: string): void
+
+  /**
+   * Asynchronous form of {@link Tar.writeTarBz2}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  writeTarBz2Async(bz2Path: string): Promise<void>
+
+  /**
+   * Creates a gzip-compressed TAR archive at `gzPath` from the files and directory trees previously
+   * added to this object. The usual extensions are `.tar.gz` and `.tgz`.
+   *
+   * Returns `true` on success and `false` on failure.
+   *
+   * **Two-layer format:** The result is a TAR byte stream compressed with gzip. TAR supplies the
+   * multi-file archive structure; gzip supplies compression.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Tar.writeTarGzAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  writeTarGz(gzPath: string): void
+
+  /**
+   * Asynchronous form of {@link Tar.writeTarGz}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Tar.abort} (which cancels it) and the {@link Tar.onPercentDone} /
+   * {@link Tar.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  writeTarGzAsync(gzPath: string): Promise<void>
+
+  /**
+   * Adds the directory tree at `rootPath` to the archive-creation source list and stores its
+   * entries beneath the archive prefix supplied in `rootPrefix`. Call this method multiple times,
+   * or combine it with {@link Tar.addDirRoot}, before calling a `WriteTar*` method.
+   *
+   * `rootPrefix` should be a relative archive path such as `abc/123` and should not end with `/`.
+   * If {@link Tar.dirPrefix} is also set, `DirPrefix` is applied first.
+   *
+   * **Path composition example:** With `DirPrefix = "package"` and `rootPrefix = "assets"`, files
+   * from this root are stored beneath `package/assets/`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  addDirRoot2(rootPrefix: string, rootPath: string): void
+
+  /**
+   * Creates a Debian binary package at `debPath` from the prepared control archive at `controlPath`
+   * and data archive at `dataPath`. The inputs are typically named `control.tar.gz` and
+   * `data.tar.gz`, or use another compression form accepted by the target Debian tooling.
+   *
+   * **Debian package structure:** A modern `.deb` file is an `ar` archive containing a
+   * `debian-binary` format marker, a `control.tar.*` member for package metadata and maintainer
+   * scripts, and a `data.tar.*` member for the installed filesystem payload.
+   *
+   * **Prepared inputs required:** This method packages the supplied control and data tarballs. The
+   * caller is responsible for making their directory layout, control metadata, permissions, and
+   * package contents valid for Debian package-management tools.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  createDeb(controlPath: string, dataPath: string, debPath: string): void
+
+  /**
+   * Adds the local file at `filePath` to the archive-creation source list and stores it using the
+   * exact archive path supplied in `pathWithinTar`. This allows the source path and the path
+   * visible inside the TAR to differ.
+   *
+   * Call this method as many times as needed, optionally together with the other file and
+   * directory-root methods, before calling a single `WriteTar*` method.
+   *
+   * **DirPrefix is not applied:** Because `pathWithinTar` already specifies the path within the
+   * TAR, {@link Tar.dirPrefix} does not modify entries added by this method. Use forward slashes
+   * and a relative path for portable archive names.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  addFile2(filePath: string, pathWithinTar: string): void
+
+  /**
+   * Scans the uncompressed TAR archive at `tarPath` and copies the contents of the first file whose
+   * archive path matches `matchPattern` into the `BinData` object supplied in `bd`. Matching is
+   * evaluated in archive order.
+   *
+   * No archive entry is written to the local filesystem. Returns `true` when a matching file is
+   * successfully extracted to `bd` and `false` otherwise.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  untarFirstMatchingToBd(tarPath: string, matchPattern: string, bd: BinData): void
+
+  /**
+   * Removes all files and directory roots previously registered by {@link Tar.addDirRoot}, {@link
+   * Tar.addDirRoot2}, {@link Tar.addFile}, and {@link Tar.addFile2}.
+   *
+   * Call this method before building a different archive with the same `Tar` object when the
+   * earlier source list should not be reused.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Tar.lastErrorText}.
+   */
+  clearDirRootsAndFiles(): void
+
+  // ---- Events (ReactNativeGen_DESIGN.md §6) ----
+
+  /**
+   * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
+   * can measure progress. Runs on the JavaScript thread, so it is only useful with the
+   * `...Async` methods (during a synchronous call the thread is busy and the events arrive
+   * after it returns). Assign `undefined` to remove.
+   */
+  onPercentDone?: (pctDone: number) => void
+
+  /**
+   * Called with a name/value pair of progress information while a long-running method runs
+   * (what is reported depends on the class and method). Runs on the JavaScript thread; see
+   * {@link Tar.onPercentDone}. Assign `undefined` to remove.
+   */
+  onProgressInfo?: (name: string, value: string) => void
+
+  /**
+   * Requests that the pending `...Async` call on this object stop at its next progress check.
+   * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
+   * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
+   * for a responsive cancel. Harmless when nothing is pending.
+   */
+  abort(): void
+}