@girs/gjs 3.0.0-beta.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/ambient.d.ts +2857 -0
- package/gjs.cjs +4 -0
- package/gjs.d.cts +2146 -0
- package/gjs.d.ts +2146 -0
- package/gjs.js +4 -0
- package/package.json +449 -0
- package/tsconfig.doc.json +19 -0
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
|
|
2
|
+
# Gjs
|
|
3
|
+
|
|
4
|
+
GJS TypeScript type definitions for Gjs using [ts-for-gir](https://github.com/gjsify/ts-for-gjs) v3.0.0-beta.12.
|
|
5
|
+
|
|
6
|
+
## Install
|
|
7
|
+
|
|
8
|
+
To use this type definitions, install them with NPM like this:
|
|
9
|
+
```bash
|
|
10
|
+
npm install @girs/gjs
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
You can import this package into your project like this:
|
|
16
|
+
```ts
|
|
17
|
+
import Gjs from '@girs/gjs';
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Or if you prefer CommonJS, you can also use this:
|
|
21
|
+
```ts
|
|
22
|
+
const Gjs = require('@girs/gjs');
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
If you want to use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can import all ambient module types like this:
|
|
26
|
+
```ts
|
|
27
|
+
import '@girs/gjs/ambient'
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
|