AppStream-1.0

GJS TypeScript type definitions for AppStream-1.0, generated from library version 0.16.2 using ts-for-gir v3.0.1.

AppStream is a cross-distro effort for enhancing the way we interact with the software repositories provided by the distribution by standardizing sets of additional metadata.

Install

To use this type definitions, install them with NPM:

npm install @girs/appstream-1.0

Usage

You can import this package into your project like this:

import AppStream from '@girs/appstream-1.0';

Or if you prefer CommonJS, you can also use this:

const AppStream = require('@girs/appstream-1.0');

Ambient Modules

You can also use ambient modules to import this module like you would do this in JavaScript. For this you need to include @girs/appstream-1.0 or @girs/appstream-1.0/ambient in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/appstream-1.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/appstream-1.0"],
  ...
}

Now you can import the ambient module with TypeScript support:

import AppStream from 'gi://AppStream?version=1.0';

Global import

You can also import the module with Typescript support using the global imports.gi object of GJS. For this you need to include @girs/appstream-1.0 or @girs/appstream-1.0/import in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/appstream-1.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/appstream-1.0"],
  ...
}

Now you have also type support for this, too:

const AppStream = imports.gi.AppStream;

Bundle

Depending on your project configuration, it is recommended to use a bundler like esbuild. You can find examples using different bundlers here.

Other packages

All existing pre-generated packages can be found on gjsify/types.