@gtkx/ffi 0.10.5 → 0.11.1

package/dist/generated/glib/date-time.d.ts

@@ -61,16 +61,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param tz - a #GTimeZone
-     * @param year - the year component of the date
-     * @param month - the month component of the date
-     * @param day - the day component of the date
-     * @param hour - the hour component of the date
-     * @param minute - the minute component of the date
-     * @param seconds - the number of seconds past the minute
      */
     constructor(tz: TimeZone, year: number, month: number, day: number, hour: number, minute: number, seconds: number);
-    constructor(_args: unknown[]);
     /**
      * Creates a #GDateTime corresponding to the given
      * [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601)
@@ -93,7 +85,7 @@ export declare class DateTime extends NativeObject {
      * - `YYYY-DDD` - Ordinal day where DDD is from 001 to 366, e.g. 2016-237.
      * - `YYYYDDD` - Same as above without dividers.
      * - `YYYY-Www-D` - Week day where ww is from 01 to 52 and D from 1-7,
-     * e.g. 2016-W34-3.
+     *   e.g. 2016-W34-3.
      * - `YYYYWwwD` - Same as above without dividers.
      *
      * `<time>` is in the form:
@@ -115,10 +107,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param text - an ISO 8601 formatted time string.
-     * @param defaultTz - a #GTimeZone to use if the text doesn't contain a
      */
-    static timeNewFromIso8601(text: string, defaultTz?: TimeZone): DateTime;
+    static newFromIso8601(text: string, defaultTz?: TimeZone | null): DateTime;
     /**
      * Creates a #GDateTime corresponding to the given #GTimeVal `tv` in the
      * local time zone.
@@ -132,9 +122,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param tv - a #GTimeVal
      */
-    static timeNewFromTimevalLocal(tv: TimeVal): DateTime;
+    static newFromTimevalLocal(tv: TimeVal): DateTime;
     /**
      * Creates a #GDateTime corresponding to the given #GTimeVal `tv` in UTC.
      *
@@ -146,9 +135,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param tv - a #GTimeVal
      */
-    static timeNewFromTimevalUtc(tv: TimeVal): DateTime;
+    static newFromTimevalUtc(tv: TimeVal): DateTime;
     /**
      * Creates a #GDateTime corresponding to the given Unix time `t` in the
      * local time zone.
@@ -161,9 +149,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param t - the Unix time
      */
-    static timeNewFromUnixLocal(t: number): DateTime;
+    static newFromUnixLocal(t: number): DateTime;
     /**
      * Creates a {@link GLib.DateTime} corresponding to the given Unix time `t` in the
      * local time zone.
@@ -176,9 +163,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling {@link GLib.DateTime.unref}
      * when you are done with it.
-     * @param usecs - the Unix time in microseconds
      */
-    static timeNewFromUnixLocalUsec(usecs: number): DateTime;
+    static newFromUnixLocalUsec(usecs: number): DateTime;
     /**
      * Creates a #GDateTime corresponding to the given Unix time `t` in UTC.
      *
@@ -190,9 +176,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param t - the Unix time
      */
-    static timeNewFromUnixUtc(t: number): DateTime;
+    static newFromUnixUtc(t: number): DateTime;
     /**
      * Creates a {@link GLib.DateTime} corresponding to the given Unix time `t` in UTC.
      *
@@ -204,23 +189,16 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling {@link GLib.DateTime.unref}
      * when you are done with it.
-     * @param usecs - the Unix time in microseconds
      */
-    static timeNewFromUnixUtcUsec(usecs: number): DateTime;
+    static newFromUnixUtcUsec(usecs: number): DateTime;
     /**
      * Creates a new #GDateTime corresponding to the given date and time in
      * the local time zone.
      *
      * This call is equivalent to calling g_date_time_new() with the time
      * zone returned by g_time_zone_new_local().
-     * @param year - the year component of the date
-     * @param month - the month component of the date
-     * @param day - the day component of the date
-     * @param hour - the hour component of the date
-     * @param minute - the minute component of the date
-     * @param seconds - the number of seconds past the minute
      */
-    static timeNewLocal(year: number, month: number, day: number, hour: number, minute: number, seconds: number): DateTime;
+    static newLocal(year: number, month: number, day: number, hour: number, minute: number, seconds: number): DateTime;
     /**
      * Creates a #GDateTime corresponding to this exact instant in the given
      * time zone `tz`.  The time is as accurate as the system allows, to a
@@ -231,9 +209,8 @@ export declare class DateTime extends NativeObject {
      *
      * You should release the return value by calling g_date_time_unref()
      * when you are done with it.
-     * @param tz - a #GTimeZone
      */
-    static timeNewNow(tz: TimeZone): DateTime;
+    static newNow(tz: TimeZone): DateTime;
     /**
      * Creates a #GDateTime corresponding to this exact instant in the local
      * time zone.
@@ -241,62 +218,42 @@ export declare class DateTime extends NativeObject {
      * This is equivalent to calling g_date_time_new_now() with the time
      * zone returned by g_time_zone_new_local().
      */
-    static timeNewNowLocal(): DateTime;
+    static newNowLocal(): DateTime;
     /**
      * Creates a #GDateTime corresponding to this exact instant in UTC.
      *
      * This is equivalent to calling g_date_time_new_now() with the time
      * zone returned by g_time_zone_new_utc().
      */
-    static timeNewNowUtc(): DateTime;
+    static newNowUtc(): DateTime;
     /**
      * Creates a new #GDateTime corresponding to the given date and time in
      * UTC.
      *
      * This call is equivalent to calling g_date_time_new() with the time
      * zone returned by g_time_zone_new_utc().
-     * @param year - the year component of the date
-     * @param month - the month component of the date
-     * @param day - the day component of the date
-     * @param hour - the hour component of the date
-     * @param minute - the minute component of the date
-     * @param seconds - the number of seconds past the minute
-     */
-    static timeNewUtc(year: number, month: number, day: number, hour: number, minute: number, seconds: number): DateTime;
-    protected createPtr(_args: unknown[]): unknown;
-    static fromPtr(ptr: unknown): DateTime;
-    /**
-     * Creates a copy of `datetime` and adds the specified timespan to the copy.
-     * @param timespan - a #GTimeSpan
      */
+    static newUtc(year: number, month: number, day: number, hour: number, minute: number, seconds: number): DateTime;
+    /** Creates a copy of `datetime` and adds the specified timespan to the copy. */
     add(timespan: number): DateTime | null;
     /**
      * Creates a copy of `datetime` and adds the specified number of days to the
      * copy. Add negative values to subtract days.
-     * @param days - the number of days
      */
     addDays(days: number): DateTime | null;
     /**
      * Creates a new #GDateTime adding the specified values to the current date and
      * time in `datetime`. Add negative values to subtract.
-     * @param years - the number of years to add
-     * @param months - the number of months to add
-     * @param days - the number of days to add
-     * @param hours - the number of hours to add
-     * @param minutes - the number of minutes to add
-     * @param seconds - the number of seconds to add
      */
     addFull(years: number, months: number, days: number, hours: number, minutes: number, seconds: number): DateTime | null;
     /**
      * Creates a copy of `datetime` and adds the specified number of hours.
      * Add negative values to subtract hours.
-     * @param hours - the number of hours to add
      */
     addHours(hours: number): DateTime | null;
     /**
      * Creates a copy of `datetime` adding the specified number of minutes.
      * Add negative values to subtract minutes.
-     * @param minutes - the number of minutes to add
      */
     addMinutes(minutes: number): DateTime | null;
     /**
@@ -307,19 +264,16 @@ export declare class DateTime extends NativeObject {
      * of days in the updated calendar month. For example, if adding 1 month to
      * 31st January 2018, the result would be 28th February 2018. In 2020 (a leap
      * year), the result would be 29th February.
-     * @param months - the number of months
      */
     addMonths(months: number): DateTime | null;
     /**
      * Creates a copy of `datetime` and adds the specified number of seconds.
      * Add negative values to subtract seconds.
-     * @param seconds - the number of seconds to add
      */
     addSeconds(seconds: number): DateTime | null;
     /**
      * Creates a copy of `datetime` and adds the specified number of weeks to the
      * copy. Add negative values to subtract weeks.
-     * @param weeks - the number of weeks
      */
     addWeeks(weeks: number): DateTime | null;
     /**
@@ -328,20 +282,17 @@ export declare class DateTime extends NativeObject {
      *
      * As with g_date_time_add_months(), if the resulting date would be 29th
      * February on a non-leap year, the day will be clamped to 28th February.
-     * @param years - the number of years
      */
     addYears(years: number): DateTime | null;
     /**
      * A comparison function for #GDateTimes that is suitable
      * as a #GCompareFunc. Both #GDateTimes must be non-%NULL.
-     * @param dt2 - second #GDateTime to compare
      */
     compare(dt2: DateTime): number;
     /**
      * Calculates the difference in time between `end` and `begin`.  The
      * #GTimeSpan that is returned is effectively `end` - `begin` (ie:
      * positive if the first parameter is larger).
-     * @param begin - a #GDateTime
      */
     difference(begin: DateTime): number;
     /**
@@ -349,7 +300,6 @@ export declare class DateTime extends NativeObject {
      *
      * Equal here means that they represent the same moment after converting
      * them to the same time zone.
-     * @param dt2 - a #GDateTime
      */
     equal(dt2: DateTime): boolean;
     /**
@@ -376,60 +326,60 @@ export declare class DateTime extends NativeObject {
      * - `%C`: the century number (year/100) as a 2-digit integer (00-99)
      * - `%d`: the day of the month as a decimal number (range 01 to 31)
      * - `%e`: the day of the month as a decimal number (range 1 to 31);
-     * single digits are preceded by a figure space (U+2007)
+     *   single digits are preceded by a figure space (U+2007)
      * - `%F`: equivalent to `%Y-%m-%d` (the ISO 8601 date format)
      * - `%g`: the last two digits of the ISO 8601 week-based year as a
-     * decimal number (00-99). This works well with `%V` and `%u`.
+     *   decimal number (00-99). This works well with `%V` and `%u`.
      * - `%G`: the ISO 8601 week-based year as a decimal number. This works
-     * well with `%V` and `%u`.
+     *   well with `%V` and `%u`.
      * - `%h`: equivalent to `%b`
      * - `%H`: the hour as a decimal number using a 24-hour clock (range 00 to 23)
      * - `%I`: the hour as a decimal number using a 12-hour clock (range 01 to 12)
      * - `%j`: the day of the year as a decimal number (range 001 to 366)
      * - `%k`: the hour (24-hour clock) as a decimal number (range 0 to 23);
-     * single digits are preceded by a figure space (U+2007)
+     *   single digits are preceded by a figure space (U+2007)
      * - `%l`: the hour (12-hour clock) as a decimal number (range 1 to 12);
-     * single digits are preceded by a figure space (U+2007)
+     *   single digits are preceded by a figure space (U+2007)
      * - `%m`: the month as a decimal number (range 01 to 12)
      * - `%M`: the minute as a decimal number (range 00 to 59)
      * - `%f`: the microsecond as a decimal number (range 000000 to 999999)
      * - `%p`: either ‘AM’ or ‘PM’ according to the given time value, or the
-     * corresponding  strings for the current locale.  Noon is treated as
-     * ‘PM’ and midnight as ‘AM’. Use of this format specifier is discouraged, as
-     * many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
+     *   corresponding  strings for the current locale.  Noon is treated as
+     *   ‘PM’ and midnight as ‘AM’. Use of this format specifier is discouraged, as
+     *   many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
      * - `%P`: like `%p` but lowercase: ‘am’ or ‘pm’ or a corresponding string for
-     * the current locale. Use of this format specifier is discouraged, as
-     * many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
+     *   the current locale. Use of this format specifier is discouraged, as
+     *   many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
      * - `%r`: the time in a.m. or p.m. notation. Use of this format specifier is
-     * discouraged, as many locales have no concept of AM/PM formatting. Use `%c`
-     * or `%X` instead.
+     *   discouraged, as many locales have no concept of AM/PM formatting. Use `%c`
+     *   or `%X` instead.
      * - `%R`: the time in 24-hour notation (`%H:%M`)
      * - `%s`: the number of seconds since the Epoch, that is, since 1970-01-01
-     * 00:00:00 UTC
+     *   00:00:00 UTC
      * - `%S`: the second as a decimal number (range 00 to 60)
      * - `%t`: a tab character
      * - `%T`: the time in 24-hour notation with seconds (`%H:%M:%S`)
      * - `%u`: the ISO 8601 standard day of the week as a decimal, range 1 to 7,
-     * Monday being 1. This works well with `%G` and `%V`.
+     *    Monday being 1. This works well with `%G` and `%V`.
      * - `%V`: the ISO 8601 standard week number of the current year as a decimal
-     * number, range 01 to 53, where week 1 is the first week that has at
-     * least 4 days in the new year. See g_date_time_get_week_of_year().
-     * This works well with `%G` and `%u`.
+     *   number, range 01 to 53, where week 1 is the first week that has at
+     *   least 4 days in the new year. See g_date_time_get_week_of_year().
+     *   This works well with `%G` and `%u`.
      * - `%w`: the day of the week as a decimal, range 0 to 6, Sunday being 0.
-     * This is not the ISO 8601 standard format — use `%u` instead.
+     *   This is not the ISO 8601 standard format — use `%u` instead.
      * - `%x`: the preferred date representation for the current locale without
-     * the time
+     *   the time
      * - `%X`: the preferred time representation for the current locale without
-     * the date
+     *   the date
      * - `%y`: the year as a decimal number without the century
      * - `%Y`: the year as a decimal number including the century
      * - `%z`: the time zone as an offset from UTC (`+hhmm`)
      * - `%:z`: the time zone as an offset from UTC (`+hh:mm`).
-     * This is a gnulib `strftime()` extension. Since: 2.38
+     *   This is a gnulib `strftime()` extension. Since: 2.38
      * - `%::z`: the time zone as an offset from UTC (`+hh:mm:ss`). This is a
-     * gnulib `strftime()` extension. Since: 2.38
+     *   gnulib `strftime()` extension. Since: 2.38
      * - `%:::z`: the time zone as an offset from UTC, with `:` to necessary
-     * precision (e.g., `-04`, `+05:30`). This is a gnulib `strftime()` extension. Since: 2.38
+     *   precision (e.g., `-04`, `+05:30`). This is a gnulib `strftime()` extension. Since: 2.38
      * - `%Z`: the time zone or name or abbreviation
      * - `%%`: a literal `%` character
      *
@@ -441,18 +391,18 @@ export declare class DateTime extends NativeObject {
      *
      * - `O`: Use alternative numeric symbols, if the current locale supports those.
      * - `_`: Pad a numeric result with spaces. This overrides the default padding
-     * for the specifier.
+     *   for the specifier.
      * - `-`: Do not pad a numeric result. This overrides the default padding
-     * for the specifier.
+     *   for the specifier.
      * - `0`: Pad a numeric result with zeros. This overrides the default padding
-     * for the specifier.
+     *   for the specifier.
      *
      * The following modifiers are supported for many of the alphabetic conversions:
      *
      * - `^`: Use upper case if possible. This is a gnulib `strftime()` extension.
-     * Since: 2.80
+     *   Since: 2.80
      * - `#`: Use opposite case if possible. This is a gnulib `strftime()`
-     * extension. Since: 2.80
+     *   extension. Since: 2.80
      *
      * Additionally, when `O` is used with `B`, `b`, or `h`, it produces the alternative
      * form of a month name. The alternative form should be used when the month
@@ -468,16 +418,15 @@ export declare class DateTime extends NativeObject {
      * names, for example.
      *
      * - `%Ec`: the preferred date and time representation for the current locale,
-     * using the alternate era representation
+     *   using the alternate era representation
      * - `%EC`: the name of the era
      * - `%Ex`: the preferred date representation for the current locale without
-     * the time, using the alternate era representation
+     *   the time, using the alternate era representation
      * - `%EX`: the preferred time representation for the current locale without
-     * the date, using the alternate era representation
+     *   the date, using the alternate era representation
      * - `%Ey`: the year since the beginning of the era denoted by the `%EC`
-     * specifier
+     *   specifier
      * - `%EY`: the full alternative year representation
-     * @param format - a valid UTF-8 string, containing the format for the
      */
     format(format: string): string | null;
     /**
@@ -503,35 +452,25 @@ export declare class DateTime extends NativeObject {
      * calendar.
      */
     getDayOfYear(): number;
-    /**
-     * Retrieves the hour of the day represented by `datetime`
-     */
+    /** Retrieves the hour of the day represented by `datetime` */
     getHour(): number;
-    /**
-     * Retrieves the microsecond of the date represented by `datetime`
-     */
+    /** Retrieves the microsecond of the date represented by `datetime` */
     getMicrosecond(): number;
-    /**
-     * Retrieves the minute of the hour represented by `datetime`
-     */
+    /** Retrieves the minute of the hour represented by `datetime` */
     getMinute(): number;
     /**
      * Retrieves the month of the year represented by `datetime` in the Gregorian
      * calendar.
      */
     getMonth(): number;
-    /**
-     * Retrieves the second of the minute represented by `datetime`
-     */
+    /** Retrieves the second of the minute represented by `datetime` */
     getSecond(): number;
     /**
      * Retrieves the number of seconds since the start of the last minute,
      * including the fractional part.
      */
     getSeconds(): number;
-    /**
-     * Get the time zone for this `datetime`.
-     */
+    /** Get the time zone for this `datetime`. */
     getTimezone(): TimeZone;
     /**
      * Determines the time zone abbreviation to be used at the time and in
@@ -605,29 +544,18 @@ export declare class DateTime extends NativeObject {
      * if 4 or more days of that week are contained within the new year.
      */
     getWeekOfYear(): number;
-    /**
-     * Retrieves the year represented by `datetime` in the Gregorian calendar.
-     */
+    /** Retrieves the year represented by `datetime` in the Gregorian calendar. */
     getYear(): number;
-    /**
-     * Retrieves the Gregorian day, month, and year of a given #GDateTime.
-     * @param year - the return location for the gregorian year, or %NULL.
-     * @param month - the return location for the month of the year, or %NULL.
-     * @param day - the return location for the day of the month, or %NULL.
-     */
-    getYmd(year?: Ref<number>, month?: Ref<number>, day?: Ref<number>): void;
-    /**
-     * Hashes `datetime` into a #guint, suitable for use within #GHashTable.
-     */
+    /** Retrieves the Gregorian day, month, and year of a given #GDateTime. */
+    getYmd(year?: Ref<number> | null, month?: Ref<number> | null, day?: Ref<number> | null): void;
+    /** Hashes `datetime` into a #guint, suitable for use within #GHashTable. */
     hash(): number;
     /**
      * Determines if daylight savings time is in effect at the time and in
      * the time zone of `datetime`.
      */
     isDaylightSavings(): boolean;
-    /**
-     * Atomically increments the reference count of `datetime` by one.
-     */
+    /** Atomically increments the reference count of `datetime` by one. */
     ref(): DateTime;
     /**
      * Creates a new #GDateTime corresponding to the same instant in time as
@@ -651,7 +579,6 @@ export declare class DateTime extends NativeObject {
      * out of range.
      *
      * On systems where 'long' is 64bit, this function never fails.
-     * @param tv - a #GTimeVal to modify
      */
     toTimeval(tv: TimeVal): boolean;
     /**
@@ -661,7 +588,6 @@ export declare class DateTime extends NativeObject {
      * This call can fail in the case that the time goes out of bounds.  For
      * example, converting 0001-01-01 00:00:00 UTC to a time zone west of
      * Greenwich will fail (due to the year 0 being out of range).
-     * @param tz - the new #GTimeZone
      */
     toTimezone(tz: TimeZone): DateTime | null;
     /**