@chilkat/react-native 11.6.1

package/src/specs/Url.nitro.ts

@@ -0,0 +1,246 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.
+ *
+ * `Url` is a focused URL parsing class. Given a full URL, it
+ * extracts the hostname, host type, login, password, path, query string,
+ * fragment, port, and SSL/TLS status into easy-to-read properties. It is useful
+ * when application code needs to inspect, validate, route, log, or pass URL
+ * parts to lower-level networking or API code.
+ *
+ * **Parse full URLs**
+ *
+ * Call `ParseUrl` to break a complete URL into structured
+ * properties that can be inspected individually.
+ *
+ * **Host and host type**
+ *
+ * Read the hostname and determine whether it is a DNS name, IPv4 address,
+ * or IPv6 address.
+ *
+ * **Path and query**
+ *
+ * Access the URL path, query string, and combined path-with-query value for
+ * request construction or routing.
+ *
+ * **Login and password**
+ *
+ * Extract embedded userinfo credentials when a URL contains a login and
+ * password component.
+ *
+ * **Port and TLS status**
+ *
+ * Determine the explicit or implied port and whether the URL represents an
+ * SSL/TLS connection.
+ *
+ * **Fragment handling**
+ *
+ * Read the URL fragment separately from the path and query for workflows
+ * that need anchor or client-side state information.
+ *
+ * **Common pattern:**
+ * Use `Url` when the application needs to decompose a URL before
+ * making a request or applying custom logic. Parse the full URL, read the
+ * properties needed by the caller, then pass the relevant pieces to classes
+ * such as `Chilkat.Http`, `Chilkat.Rest`, or
+ * `Chilkat.Socket`. Use `Url` for parsing; use the
+ * higher-level networking classes to actually send the request.
+ *
+ * For an extended overview, see
+ * [Url Class Overview](https://www.chilkatsoft.com/url_class_overview.asp).
+ *
+ * Each `Url` 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 Url()`.
+ */
+export interface Url 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
+
+  /**
+   * Contains any text following a fragment marker (#) in the URL, excluding the fragment marker.
+   * Given the URI <http://www.contoso.com/index.htm#main>, the fragment is `main`.
+   *
+   * This property is read-only.
+   */
+  readonly frag: string
+
+  /**
+   * The DNS host name or IP address part of the URL. For example, if the URL is
+   * `http://www.contoso.com:8080/`, the Host is `www.contoso.com`. If the URL is
+   * `https://192.168.1.124/test.html`, the Host is `192.168.1.124`.
+   *
+   * This property is read-only.
+   */
+  readonly host: string
+
+  /**
+   * The type of the host name specified in the URL.   Possible values are:
+   *
+   * - `dns`: The host name is a domain name system (DNS) style host name.
+   *
+   * - `ipv4`: The host name is an Internet Protocol (IP) version 4 host address.
+   *
+   * - `ipv6`: The host name is an Internet Protocol (IP) version 6 host address.
+   *
+   * This property is read-only.
+   */
+  readonly hostType: string
+
+  /**
+   * If the URL contains a login and password, this is the login part. For example, if the URL is
+   * `http://user:password@www.contoso.com/index.htm`, then the login is `user`.
+   *
+   * This property is read-only.
+   */
+  readonly login: string
+
+  /**
+   * If the URL contains a login and password, this is the password part. For example, if the URL is
+   * `http://user:password@www.contoso.com/index.htm`, then the password is `password`.
+   *
+   * This property is read-only.
+   */
+  readonly password: string
+
+  /**
+   * The path (and params) part of the URL, excluding the query and fragment. If the URL is:
+   * `http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`,
+   * then the path is `/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3`.
+   *
+   * This property is read-only.
+   */
+  readonly path: string
+
+  /**
+   * The port number of the URL.
+   *
+   * For example, if the URL is `http://www.contoso.com:8080/`, the port number is 8080.
+   *
+   * If the URL is `https://192.168.1.124/test.html`,  the port number is the default 80.
+   *
+   * If the URL is `https://www.amazon.com/`, the port number is the default SSL/TLS port 443.
+   *
+   * This property is read-only.
+   */
+  readonly port: number
+
+  /**
+   * The query part of the URL, excluding the fragment. If the URL is:
+   * `http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1#frag`,
+   * then the query  is `pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`.
+   *
+   * This property is read-only.
+   */
+  readonly query: string
+
+  /**
+   * `true` if the URL indicates SSL/TLS, otherwise false. A URL beginning with `https://` indicates
+   * SSL/TLS.
+   *
+   * This property is read-only.
+   */
+  readonly ssl: boolean
+
+  /**
+   * The path (and params) part of the URL, including the query params, but excluding the fragment.
+   * If the URL is:
+   * `http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`,
+   * then then this property returns
+   * `/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`.
+   *
+   * This property is read-only.
+   */
+  readonly pathWithQueryParams: string
+
+  /**
+   * The scheme part of the URL. For example, if the URL is `https://www.contoso.com:8080/`, the
+   * Scheme is `https`.
+   *
+   * This property is read-only.
+   */
+  readonly scheme: string
+
+  // ---- Methods ----
+
+  /**
+   * Parses a full URL. After parsing, the various parts of the URL are available iin the
+   * properties.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Url.lastErrorText}.
+   */
+  parseUrl(url: string): void
+}