@girs/gmodule-2.0
Advanced tools
Comparing version 2.0.0-3.3.0 to 2.0.0-4.0.0-beta.1
declare module 'gi://GModule?version=2.0' { | ||
import GModule20 from '@girs/gmodule-2.0'; | ||
export default GModule20; | ||
import GModule from '@girs/gmodule-2.0'; | ||
export default GModule; | ||
} | ||
declare module 'gi://GModule' { | ||
import GModule20 from '@girs/gmodule-2.0'; | ||
import GModule20 from 'gi://GModule?version=2.0'; | ||
export default GModule20; | ||
@@ -10,0 +10,0 @@ } |
@@ -1,2 +0,1 @@ | ||
/* | ||
@@ -10,3 +9,3 @@ * Type Definitions for Gjs (https://gjs.guide/) | ||
import './gmodule-2.0-ambient.d.ts'; | ||
import './gmodule-2.0-import.d.ts'; | ||
/** | ||
@@ -20,138 +19,25 @@ * GModule-2.0 | ||
export namespace GModule { | ||
/** | ||
* Errors returned by g_module_open_full(). | ||
*/ | ||
enum ModuleError { | ||
/** | ||
* there was an error loading or opening a module file | ||
* Errors returned by g_module_open_full(). | ||
*/ | ||
FAILED, | ||
/** | ||
* a module returned an error from its `g_module_check_init()` function | ||
*/ | ||
CHECK_FAILED, | ||
} | ||
/** | ||
* Flags passed to g_module_open(). | ||
* Note that these flags are not supported on all platforms. | ||
* @bitfield | ||
*/ | ||
enum ModuleFlags { | ||
/** | ||
* specifies that symbols are only resolved when | ||
* needed. The default action is to bind all symbols when the module | ||
* is loaded. | ||
*/ | ||
LAZY, | ||
/** | ||
* specifies that symbols in the module should | ||
* not be added to the global name space. The default action on most | ||
* platforms is to place symbols in the module in the global name space, | ||
* which may cause conflicts with existing symbols. | ||
*/ | ||
LOCAL, | ||
/** | ||
* mask for all flags. | ||
*/ | ||
MASK, | ||
} | ||
/** | ||
* A portable way to build the filename of a module. The platform-specific | ||
* prefix and suffix are added to the filename, if needed, and the result | ||
* is added to the directory, using the correct separator character. | ||
* | ||
* The directory should specify the directory where the module can be found. | ||
* It can be %NULL or an empty string to indicate that the module is in a | ||
* standard platform-specific directory, though this is not recommended | ||
* since the wrong module may be found. | ||
* | ||
* For example, calling g_module_build_path() on a Linux system with a | ||
* `directory` of `/lib` and a `module_name` of "mylibrary" will return | ||
* `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the | ||
* directory it will return `\Windows\mylibrary.dll`. | ||
* @param directory the directory where the module is. This can be %NULL or the empty string to indicate that the standard platform-specific directories will be used, though that is not recommended | ||
* @param module_name the name of the module | ||
* @returns the complete path of the module, including the standard library prefix and suffix. This should be freed when no longer needed | ||
*/ | ||
function module_build_path(directory: string | null, module_name: string): string | null | ||
/** | ||
* Gets a string describing the last module error. | ||
* @returns a string describing the last module error | ||
*/ | ||
function module_error(): string | ||
function module_error_quark(): GLib.Quark | ||
/** | ||
* Checks if modules are supported on the current platform. | ||
* @returns %TRUE if modules are supported | ||
*/ | ||
function module_supported(): boolean | ||
/** | ||
* Specifies the type of the module initialization function. | ||
* If a module contains a function named g_module_check_init() it is called | ||
* automatically when the module is loaded. It is passed the #GModule structure | ||
* and should return %NULL on success or a string describing the initialization | ||
* error. | ||
* @callback | ||
* @param module the #GModule corresponding to the module which has just been loaded | ||
* @returns %NULL on success, or a string describing the initialization error | ||
*/ | ||
interface ModuleCheckInit { | ||
(module: Module): string | ||
} | ||
/** | ||
* Specifies the type of the module function called when it is unloaded. | ||
* If a module contains a function named g_module_unload() it is called | ||
* automatically when the module is unloaded. | ||
* It is passed the #GModule structure. | ||
* @callback | ||
* @param module the #GModule about to be unloaded | ||
*/ | ||
interface ModuleUnload { | ||
(module: Module): void | ||
} | ||
interface Module { | ||
class ModuleError extends GLib.Error { | ||
static $gtype: GObject.GType<ModuleError>; | ||
// Owm methods of GModule-2.0.GModule.Module | ||
// Static fields of GModule.ModuleError | ||
/** | ||
* Closes a module. | ||
* @returns %TRUE on success | ||
*/ | ||
close(): boolean | ||
/** | ||
* Ensures that a module will never be unloaded. | ||
* Any future g_module_close() calls on the module will be ignored. | ||
*/ | ||
make_resident(): void | ||
/** | ||
* Returns the filename that the module was opened with. | ||
* | ||
* If `module` refers to the application itself, "main" is returned. | ||
* @returns the filename of the module | ||
*/ | ||
name(): string | ||
/** | ||
* Gets a symbol pointer from a module, such as one exported | ||
* by %G_MODULE_EXPORT. Note that a valid symbol can be %NULL. | ||
* @param symbol_name the name of the symbol to find | ||
* @returns %TRUE on success | ||
*/ | ||
symbol(symbol_name: string): [ /* returnType */ boolean, /* symbol */ any | null ] | ||
} | ||
/** | ||
* there was an error loading or opening a module file | ||
*/ | ||
static FAILED: number; | ||
/** | ||
* a module returned an error from its `g_module_check_init()` function | ||
*/ | ||
static CHECK_FAILED: number; | ||
/** | ||
* The #GModule struct is an opaque data structure to represent a | ||
* [dynamically-loaded module][glib-Dynamic-Loading-of-Modules]. | ||
* It should only be accessed via the following functions. | ||
* @record | ||
*/ | ||
class Module { | ||
// Constructors of GModule.ModuleError | ||
// Own properties of GModule-2.0.GModule.Module | ||
constructor(options: { message: string; code: number }); | ||
_init(...args: any[]): void; | ||
} | ||
static name: string | ||
// Constructors of GModule-2.0.GModule.Module | ||
/** | ||
@@ -161,3 +47,3 @@ * A portable way to build the filename of a module. The platform-specific | ||
* is added to the directory, using the correct separator character. | ||
* | ||
* | ||
* The directory should specify the directory where the module can be found. | ||
@@ -167,3 +53,3 @@ * It can be %NULL or an empty string to indicate that the module is in a | ||
* since the wrong module may be found. | ||
* | ||
* | ||
* For example, calling g_module_build_path() on a Linux system with a | ||
@@ -177,3 +63,3 @@ * `directory` of `/lib` and a `module_name` of "mylibrary" will return | ||
*/ | ||
static build_path(directory: string | null, module_name: string): string | null | ||
function module_build_path(directory: string | null, module_name: string): string; | ||
/** | ||
@@ -183,4 +69,4 @@ * Gets a string describing the last module error. | ||
*/ | ||
static error(): string | ||
static error_quark(): GLib.Quark | ||
function module_error(): string; | ||
function module_error_quark(): GLib.Quark; | ||
/** | ||
@@ -190,18 +76,115 @@ * Checks if modules are supported on the current platform. | ||
*/ | ||
static supported(): boolean | ||
} | ||
function module_supported(): boolean; | ||
interface ModuleCheckInit { | ||
(module: Module): string; | ||
} | ||
interface ModuleUnload { | ||
(module: Module): void; | ||
} | ||
/** | ||
* Flags passed to g_module_open(). | ||
* Note that these flags are not supported on all platforms. | ||
*/ | ||
enum ModuleFlags { | ||
/** | ||
* specifies that symbols are only resolved when | ||
* needed. The default action is to bind all symbols when the module | ||
* is loaded. | ||
*/ | ||
LAZY, | ||
/** | ||
* specifies that symbols in the module should | ||
* not be added to the global name space. The default action on most | ||
* platforms is to place symbols in the module in the global name space, | ||
* which may cause conflicts with existing symbols. | ||
*/ | ||
LOCAL, | ||
/** | ||
* mask for all flags. | ||
*/ | ||
MASK, | ||
} | ||
/** | ||
* The #GModule struct is an opaque data structure to represent a | ||
* [dynamically-loaded module][glib-Dynamic-Loading-of-Modules]. | ||
* It should only be accessed via the following functions. | ||
*/ | ||
abstract class Module { | ||
static $gtype: GObject.GType<Module>; | ||
/** | ||
* Name of the imported GIR library | ||
* @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188 | ||
*/ | ||
const __name__: string | ||
/** | ||
* Version of the imported GIR library | ||
* @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189 | ||
*/ | ||
const __version__: string | ||
// Constructors of GModule.Module | ||
_init(...args: any[]): void; | ||
// Own static methods of GModule.Module | ||
/** | ||
* A portable way to build the filename of a module. The platform-specific | ||
* prefix and suffix are added to the filename, if needed, and the result | ||
* is added to the directory, using the correct separator character. | ||
* | ||
* The directory should specify the directory where the module can be found. | ||
* It can be %NULL or an empty string to indicate that the module is in a | ||
* standard platform-specific directory, though this is not recommended | ||
* since the wrong module may be found. | ||
* | ||
* For example, calling g_module_build_path() on a Linux system with a | ||
* `directory` of `/lib` and a `module_name` of "mylibrary" will return | ||
* `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the | ||
* directory it will return `\Windows\mylibrary.dll`. | ||
* @param directory the directory where the module is. This can be %NULL or the empty string to indicate that the standard platform-specific directories will be used, though that is not recommended | ||
* @param module_name the name of the module | ||
*/ | ||
static build_path(directory: string | null, module_name: string): string; | ||
/** | ||
* Gets a string describing the last module error. | ||
*/ | ||
static error(): string; | ||
static error_quark(): GLib.Quark; | ||
/** | ||
* Checks if modules are supported on the current platform. | ||
*/ | ||
static supported(): boolean; | ||
// Own methods of GModule.Module | ||
/** | ||
* Closes a module. | ||
* @returns %TRUE on success | ||
*/ | ||
close(): boolean; | ||
/** | ||
* Ensures that a module will never be unloaded. | ||
* Any future g_module_close() calls on the module will be ignored. | ||
*/ | ||
make_resident(): void; | ||
/** | ||
* Returns the filename that the module was opened with. | ||
* | ||
* If `module` refers to the application itself, "main" is returned. | ||
* @returns the filename of the module | ||
*/ | ||
name(): string; | ||
/** | ||
* Gets a symbol pointer from a module, such as one exported | ||
* by %G_MODULE_EXPORT. Note that a valid symbol can be %NULL. | ||
* @param symbol_name the name of the symbol to find | ||
* @returns %TRUE on success | ||
*/ | ||
symbol(symbol_name: string): [boolean, any]; | ||
} | ||
/** | ||
* Name of the imported GIR library | ||
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188 | ||
*/ | ||
const __name__: string; | ||
/** | ||
* Version of the imported GIR library | ||
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189 | ||
*/ | ||
const __version__: string; | ||
} | ||
export default GModule; | ||
// END | ||
// END |
// @ts-expect-error | ||
@@ -8,4 +7,1 @@ import GModule from 'gi://GModule?version=2.0'; | ||
{ | ||
"name": "@girs/gmodule-2.0", | ||
"version": "2.0.0-3.3.0", | ||
"version": "2.0.0-4.0.0-beta.1", | ||
"description": "GJS TypeScript type definitions for GModule-2.0, generated from library version 2.0.0", | ||
@@ -11,2 +11,3 @@ "type": "module", | ||
"types": "./gmodule-2.0-ambient.d.ts", | ||
"import": "./gmodule-2.0-ambient.js", | ||
"default": "./gmodule-2.0-ambient.js" | ||
@@ -16,24 +17,18 @@ }, | ||
"types": "./gmodule-2.0-import.d.ts", | ||
"import": "./gmodule-2.0-import.js", | ||
"default": "./gmodule-2.0-import.js" | ||
}, | ||
".": { | ||
"import": { | ||
"types": "./gmodule-2.0.d.ts", | ||
"default": "./gmodule-2.0.js" | ||
}, | ||
"require": { | ||
"types": "./gmodule-2.0.d.cts", | ||
"default": "./gmodule-2.0.cjs" | ||
} | ||
"types": "./gmodule-2.0.d.ts", | ||
"import": "./gmodule-2.0.js", | ||
"default": "./gmodule-2.0.js" | ||
} | ||
}, | ||
"scripts": { | ||
"test": "yarn test:esm && yarn test:cjs", | ||
"test:esm": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gmodule-2.0.d.ts", | ||
"test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gmodule-2.0.d.cts" | ||
"test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gmodule-2.0.d.ts" | ||
}, | ||
"dependencies": { | ||
"@girs/gjs": "^3.3.0", | ||
"@girs/glib-2.0": "^2.78.0-3.3.0", | ||
"@girs/gobject-2.0": "^2.78.0-3.3.0" | ||
"@girs/gjs": "^4.0.0-beta.1", | ||
"@girs/glib-2.0": "^2.77.0-4.0.0-beta.1", | ||
"@girs/gobject-2.0": "^2.77.0-4.0.0-beta.1" | ||
}, | ||
@@ -40,0 +35,0 @@ "devDependencies": { |
@@ -8,5 +8,4 @@ | ||
GJS TypeScript type definitions for GModule-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.3.0. | ||
GJS TypeScript type definitions for GModule-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.1. | ||
Portable method for dynamically loading 'plug-ins' | ||
@@ -13,0 +12,0 @@ ## Install |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
13364
10
215
105
+ Added@girs/cairo-1.0@1.0.0-4.0.0-beta.19(transitive)
+ Added@girs/gio-2.0@2.82.2-4.0.0-beta.19(transitive)
+ Added@girs/gjs@4.0.0-beta.19(transitive)
+ Added@girs/glib-2.0@2.77.0-4.0.0-beta.12.82.2-4.0.0-beta.19(transitive)
+ Added@girs/gmodule-2.0@2.0.0-4.0.0-beta.19(transitive)
+ Added@girs/gobject-2.0@2.77.0-4.0.0-beta.12.82.2-4.0.0-beta.19(transitive)
- Removed@girs/gjs@3.3.0(transitive)
- Removed@girs/glib-2.0@2.78.0-3.3.0(transitive)
- Removed@girs/gobject-2.0@2.78.0-3.3.0(transitive)
Updated@girs/gjs@^4.0.0-beta.1