@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/glib/bookmark-file.d.ts

@@ -1,55 +1,568 @@
 import { Ref } from "@gtkx/native";
 import { DateTime } from "./date-time.js";
+/**
+ * `GBookmarkFile` lets you parse, edit or create files containing bookmarks.
+ *
+ * Bookmarks refer to a URI, along with some meta-data about the resource
+ * pointed by the URI like its MIME type, the application that is registering
+ * the bookmark and the icon that should be used to represent the bookmark.
+ * The data is stored using the
+ * [Desktop Bookmark Specification](https://www.freedesktop.org/wiki/Specifications/desktop-bookmark-spec/).
+ *
+ * The syntax of the bookmark files is described in detail inside the
+ * Desktop Bookmark Specification, here is a quick summary: bookmark
+ * files use a sub-class of the XML Bookmark Exchange Language
+ * specification, consisting of valid UTF-8 encoded XML, under the
+ * `<xbel>` root element; each bookmark is stored inside a
+ * `<bookmark>` element, using its URI: no relative paths can
+ * be used inside a bookmark file. The bookmark may have a user defined
+ * title and description, to be used instead of the URI. Under the
+ * `<metadata>` element, with its owner attribute set to
+ * `http://freedesktop.org`, is stored the meta-data about a resource
+ * pointed by its URI. The meta-data consists of the resource's MIME
+ * type; the applications that have registered a bookmark; the groups
+ * to which a bookmark belongs to; a visibility flag, used to set the
+ * bookmark as "private" to the applications and groups that has it
+ * registered; the URI and MIME type of an icon, to be used when
+ * displaying the bookmark inside a GUI.
+ *
+ * Here is an example of a bookmark file:
+ * [bookmarks.xbel](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/glib/tests/bookmarks.xbel)
+ *
+ * A bookmark file might contain more than one bookmark; each bookmark
+ * is accessed through its URI.
+ *
+ * The important caveat of bookmark files is that when you add a new
+ * bookmark you must also add the application that is registering it, using
+ * [method@GLib.BookmarkFile.add_application] or [method@GLib.BookmarkFile.set_application_info].
+ * If a bookmark has no applications then it won't be dumped when creating
+ * the on disk representation, using [method@GLib.BookmarkFile.to_data] or
+ * [method@GLib.BookmarkFile.to_file].
+ */
 export declare class BookmarkFile {
     ptr: unknown;
+    /**
+     * Creates a new empty #GBookmarkFile object.
+     *
+     * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
+     * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
+     * file.
+     */
     constructor();
     protected createPtr(_args: unknown[]): unknown;
     static errorQuark(): number;
+    /**
+     * Adds the application with `name` and `exec` to the list of
+     * applications that have registered a bookmark for `uri` into
+     * @bookmark.
+     *
+     * Every bookmark inside a #GBookmarkFile must have at least an
+     * application registered.  Each application must provide a name, a
+     * command line useful for launching the bookmark, the number of times
+     * the bookmark has been registered by the application and the last
+     * time the application registered this bookmark.
+     *
+     * If `name` is %NULL, the name of the application will be the
+     * same returned by g_get_application_name(); if `exec` is %NULL, the
+     * command line will be a composition of the program name as
+     * returned by g_get_prgname() and the "\%u" modifier, which will be
+     * expanded to the bookmark's URI.
+     *
+     * This function will automatically take care of updating the
+     * registrations count and timestamping in case an application
+     * with the same `name` had already registered a bookmark for
+     * `uri` inside @bookmark.
+     *
+     * If no bookmark for `uri` is found, one is created.
+     * @param uri - a valid URI
+     * @param name - the name of the application registering the bookmark
+     * @param exec - command line to be used to launch the bookmark or %NULL
+     */
     addApplication(uri: string, name?: string | null, exec?: string | null): void;
+    /**
+     * Adds `group` to the list of groups to which the bookmark for `uri` belongs to.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     * @param uri - a valid URI
+     * @param group - the group name to be added
+     */
     addGroup(uri: string, group: string): void;
+    /**
+     * Deeply copies a `bookmark` #GBookmarkFile object to a new one.
+     */
     copy(): BookmarkFile;
+    /**
+     * Frees a #GBookmarkFile.
+     */
     free(): void;
+    /**
+     * Gets the time the bookmark for `uri` was added to `bookmark`
+     * In the event the URI cannot be found, -1 is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getAdded(uri: string): number;
+    /**
+     * Gets the time the bookmark for `uri` was added to `bookmark`
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getAddedDateTime(uri: string): DateTime;
+    /**
+     * Gets the registration information of `app_name` for the bookmark for
+     * @uri.  See g_bookmark_file_set_application_info() for more information about
+     * the returned data.
+     *
+     * The string returned in `app_exec` must be freed.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that no application with name `app_name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
+     * the command line fails, an error of the %G_SHELL_ERROR domain is
+     * set and %FALSE is returned.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - return location for the command line of the application, or %NULL
+     * @param count - return location for the registration count, or %NULL
+     * @param stamp - return location for the last registration time, or %NULL
+     */
     getAppInfo(uri: string, name: string, exec?: Ref<string> | null, count?: Ref<number> | null, stamp?: Ref<number> | null): boolean;
+    /**
+     * Gets the registration information of `app_name` for the bookmark for
+     * @uri.  See g_bookmark_file_set_application_info() for more information about
+     * the returned data.
+     *
+     * The string returned in `app_exec` must be freed.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that no application with name `app_name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
+     * the command line fails, an error of the %G_SHELL_ERROR domain is
+     * set and %FALSE is returned.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - return location for the command line of the application, or %NULL
+     * @param count - return location for the registration count, or %NULL
+     * @param stamp - return location for the last registration time, or %NULL
+     */
     getApplicationInfo(uri: string, name: string, exec?: Ref<string> | null, count?: Ref<number> | null, stamp?: Ref<DateTime> | null): boolean;
+    /**
+     * Retrieves the names of the applications that have registered the
+     * bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param length - return location of the length of the returned list, or %NULL
+     */
     getApplications(uri: string, length?: Ref<number> | null): string[];
+    /**
+     * Retrieves the description of the bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getDescription(uri: string): string;
+    /**
+     * Retrieves the list of group names of the bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     *
+     * The returned array is %NULL terminated, so `length` may optionally
+     * be %NULL.
+     * @param uri - a valid URI
+     * @param length - return location for the length of the returned string, or %NULL
+     */
     getGroups(uri: string, length?: Ref<number> | null): string[];
+    /**
+     * Gets the icon of the bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param href - return location for the icon's location or %NULL
+     * @param mimeType - return location for the icon's MIME type or %NULL
+     */
     getIcon(uri: string, href?: Ref<string> | null, mimeType?: Ref<string> | null): boolean;
+    /**
+     * Gets whether the private flag of the bookmark for `uri` is set.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that the private flag cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
+     * @param uri - a valid URI
+     */
     getIsPrivate(uri: string): boolean;
+    /**
+     * Retrieves the MIME type of the resource pointed by @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that the MIME type cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
+     * @param uri - a valid URI
+     */
     getMimeType(uri: string): string;
+    /**
+     * Gets the time when the bookmark for `uri` was last modified.
+     *
+     * In the event the URI cannot be found, -1 is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getModified(uri: string): number;
+    /**
+     * Gets the time when the bookmark for `uri` was last modified.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getModifiedDateTime(uri: string): DateTime;
+    /**
+     * Gets the number of bookmarks inside @bookmark.
+     */
     getSize(): number;
+    /**
+     * Returns the title of the bookmark for @uri.
+     *
+     * If `uri` is %NULL, the title of `bookmark` is returned.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI or %NULL
+     */
     getTitle(uri?: string | null): string;
+    /**
+     * Returns all URIs of the bookmarks in the bookmark file @bookmark.
+     * The array of returned URIs will be %NULL-terminated, so `length` may
+     * optionally be %NULL.
+     * @param length - return location for the number of returned URIs, or %NULL
+     */
     getUris(length?: Ref<number> | null): string[];
+    /**
+     * Gets the time the bookmark for `uri` was last visited.
+     *
+     * In the event the URI cannot be found, -1 is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getVisited(uri: string): number;
+    /**
+     * Gets the time the bookmark for `uri` was last visited.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getVisitedDateTime(uri: string): DateTime;
+    /**
+     * Checks whether the bookmark for `uri` inside `bookmark` has been
+     * registered by application @name.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param name - the name of the application
+     */
     hasApplication(uri: string, name: string): boolean;
+    /**
+     * Checks whether `group` appears in the list of groups to which
+     * the bookmark for `uri` belongs to.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param group - the group name to be searched
+     */
     hasGroup(uri: string, group: string): boolean;
+    /**
+     * Looks whether the desktop bookmark has an item with its URI set to @uri.
+     * @param uri - a valid URI
+     */
     hasItem(uri: string): boolean;
+    /**
+     * Loads a bookmark file from memory into an empty #GBookmarkFile
+     * structure.  If the object cannot be created then `error` is set to a
+     * #GBookmarkFileError.
+     * @param data - desktop bookmarks
+     * @param length - the length of `data` in bytes
+     */
     loadFromData(data: number[], length: number): boolean;
+    /**
+     * This function looks for a desktop bookmark file named `file` in the
+     * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
+     * loads the file into `bookmark` and returns the file's full path in
+     * @full_path.  If the file could not be loaded then `error` is
+     * set to either a #GFileError or #GBookmarkFileError.
+     * @param file - a relative path to a filename to open and parse
+     * @param fullPath - return location for a string
+     */
     loadFromDataDirs(file: string, fullPath?: Ref<string> | null): boolean;
+    /**
+     * Loads a desktop bookmark file into an empty #GBookmarkFile structure.
+     * If the file could not be loaded then `error` is set to either a #GFileError
+     * or #GBookmarkFileError.
+     * @param filename - the path of a filename to load, in the
+     */
     loadFromFile(filename: string): boolean;
+    /**
+     * Changes the URI of a bookmark item from `old_uri` to @new_uri.  Any
+     * existing bookmark for `new_uri` will be overwritten.  If `new_uri` is
+     * %NULL, then the bookmark is removed.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param oldUri - a valid URI
+     * @param newUri - a valid URI, or %NULL
+     */
     moveItem(oldUri: string, newUri?: string | null): boolean;
+    /**
+     * Removes application registered with `name` from the list of applications
+     * that have registered a bookmark for `uri` inside @bookmark.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * In the event that no application with name `app_name` has registered
+     * a bookmark for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
+     * @param uri - a valid URI
+     * @param name - the name of the application
+     */
     removeApplication(uri: string, name: string): boolean;
+    /**
+     * Removes `group` from the list of groups to which the bookmark
+     * for `uri` belongs to.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * In the event no group was defined, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
+     * @param uri - a valid URI
+     * @param group - the group name to be removed
+     */
     removeGroup(uri: string, group: string): boolean;
+    /**
+     * Removes the bookmark for `uri` from the bookmark file @bookmark.
+     * @param uri - a valid URI
+     */
     removeItem(uri: string): boolean;
+    /**
+     * Sets the time the bookmark for `uri` was added into @bookmark.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     * @param uri - a valid URI
+     * @param added - a timestamp or -1 to use the current time
+     */
     setAdded(uri: string, added: number): void;
+    /**
+     * Sets the time the bookmark for `uri` was added into @bookmark.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     * @param uri - a valid URI
+     * @param added - a #GDateTime
+     */
     setAddedDateTime(uri: string, added: DateTime): void;
+    /**
+     * Sets the meta-data of application `name` inside the list of
+     * applications that have registered a bookmark for `uri` inside
+     * @bookmark.
+     *
+     * You should rarely use this function; use g_bookmark_file_add_application()
+     * and g_bookmark_file_remove_application() instead.
+     *
+     * `name` can be any UTF-8 encoded string used to identify an
+     * application.
+     * `exec` can have one of these two modifiers: "\%f", which will
+     * be expanded as the local file name retrieved from the bookmark's
+     * URI; "\%u", which will be expanded as the bookmark's URI.
+     * The expansion is done automatically when retrieving the stored
+     * command line using the g_bookmark_file_get_application_info() function.
+     * `count` is the number of times the application has registered the
+     * bookmark; if is < 0, the current registration count will be increased
+     * by one, if is 0, the application with `name` will be removed from
+     * the list of registered applications.
+     * `stamp` is the Unix time of the last registration; if it is -1, the
+     * current time will be used.
+     *
+     * If you try to remove an application by setting its registration count to
+     * zero, and no bookmark for `uri` is found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
+     * in the event that no application `name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.  Otherwise, if no bookmark
+     * for `uri` is found, one is created.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - an application's command line
+     * @param count - the number of registrations done for this application
+     * @param stamp - the time of the last registration for this application
+     */
     setAppInfo(uri: string, name: string, exec: string, count: number, stamp: number): boolean;
+    /**
+     * Sets the meta-data of application `name` inside the list of
+     * applications that have registered a bookmark for `uri` inside
+     * @bookmark.
+     *
+     * You should rarely use this function; use g_bookmark_file_add_application()
+     * and g_bookmark_file_remove_application() instead.
+     *
+     * `name` can be any UTF-8 encoded string used to identify an
+     * application.
+     * `exec` can have one of these two modifiers: "\%f", which will
+     * be expanded as the local file name retrieved from the bookmark's
+     * URI; "\%u", which will be expanded as the bookmark's URI.
+     * The expansion is done automatically when retrieving the stored
+     * command line using the g_bookmark_file_get_application_info() function.
+     * `count` is the number of times the application has registered the
+     * bookmark; if is < 0, the current registration count will be increased
+     * by one, if is 0, the application with `name` will be removed from
+     * the list of registered applications.
+     * `stamp` is the Unix time of the last registration.
+     *
+     * If you try to remove an application by setting its registration count to
+     * zero, and no bookmark for `uri` is found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
+     * in the event that no application `name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.  Otherwise, if no bookmark
+     * for `uri` is found, one is created.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - an application's command line
+     * @param count - the number of registrations done for this application
+     * @param stamp - the time of the last registration for this application,
+     */
     setApplicationInfo(uri: string, name: string, exec: string, count: number, stamp?: DateTime | null): boolean;
+    /**
+     * Sets `description` as the description of the bookmark for @uri.
+     *
+     * If `uri` is %NULL, the description of `bookmark` is set.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI or %NULL
+     * @param description - a string
+     */
     setDescription(description: string, uri?: string | null): void;
+    /**
+     * Sets a list of group names for the item with URI @uri.  Each previously
+     * set group name list is removed.
+     *
+     * If `uri` cannot be found then an item for it is created.
+     * @param uri - an item's URI
+     * @param groups - an array of
+     * @param length - number of group name values in @groups
+     */
     setGroups(uri: string, length: number, groups?: string[] | null): void;
+    /**
+     * Sets the icon for the bookmark for @uri. If `href` is %NULL, unsets
+     * the currently set icon. `href` can either be a full URL for the icon
+     * file or the icon name following the Icon Naming specification.
+     *
+     * If no bookmark for `uri` is found one is created.
+     * @param uri - a valid URI
+     * @param href - the URI of the icon for the bookmark, or %NULL
+     * @param mimeType - the MIME type of the icon for the bookmark
+     */
     setIcon(uri: string, mimeType: string, href?: string | null): void;
+    /**
+     * Sets the private flag of the bookmark for @uri.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI
+     * @param isPrivate - %TRUE if the bookmark should be marked as private
+     */
     setIsPrivate(uri: string, isPrivate: boolean): void;
+    /**
+     * Sets `mime_type` as the MIME type of the bookmark for @uri.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI
+     * @param mimeType - a MIME type
+     */
     setMimeType(uri: string, mimeType: string): void;
+    /**
+     * Sets the last time the bookmark for `uri` was last modified.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "modified" time should only be set when the bookmark's meta-data
+     * was actually changed.  Every function of #GBookmarkFile that
+     * modifies a bookmark also changes the modification time, except for
+     * g_bookmark_file_set_visited_date_time().
+     * @param uri - a valid URI
+     * @param modified - a timestamp or -1 to use the current time
+     */
     setModified(uri: string, modified: number): void;
+    /**
+     * Sets the last time the bookmark for `uri` was last modified.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "modified" time should only be set when the bookmark's meta-data
+     * was actually changed.  Every function of #GBookmarkFile that
+     * modifies a bookmark also changes the modification time, except for
+     * g_bookmark_file_set_visited_date_time().
+     * @param uri - a valid URI
+     * @param modified - a #GDateTime
+     */
     setModifiedDateTime(uri: string, modified: DateTime): void;
+    /**
+     * Sets `title` as the title of the bookmark for `uri` inside the
+     * bookmark file @bookmark.
+     *
+     * If `uri` is %NULL, the title of `bookmark` is set.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI or %NULL
+     * @param title - a UTF-8 encoded string
+     */
     setTitle(title: string, uri?: string | null): void;
+    /**
+     * Sets the time the bookmark for `uri` was last visited.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "visited" time should only be set if the bookmark was launched,
+     * either using the command line retrieved by g_bookmark_file_get_application_info()
+     * or by the default application for the bookmark's MIME type, retrieved
+     * using g_bookmark_file_get_mime_type().  Changing the "visited" time
+     * does not affect the "modified" time.
+     * @param uri - a valid URI
+     * @param visited - a timestamp or -1 to use the current time
+     */
     setVisited(uri: string, visited: number): void;
+    /**
+     * Sets the time the bookmark for `uri` was last visited.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "visited" time should only be set if the bookmark was launched,
+     * either using the command line retrieved by g_bookmark_file_get_application_info()
+     * or by the default application for the bookmark's MIME type, retrieved
+     * using g_bookmark_file_get_mime_type().  Changing the "visited" time
+     * does not affect the "modified" time.
+     * @param uri - a valid URI
+     * @param visited - a #GDateTime
+     */
     setVisitedDateTime(uri: string, visited: DateTime): void;
+    /**
+     * This function outputs `bookmark` as a string.
+     * @param length - return location for the length of the returned string, or %NULL
+     */
     toData(length?: Ref<number> | null): number[];
+    /**
+     * This function outputs `bookmark` into a file.  The write process is
+     * guaranteed to be atomic by using g_file_set_contents() internally.
+     * @param filename - path of the output file
+     */
     toFile(filename: string): boolean;
 }