@openfin/core

OpenFin Core

This package contains the type definitions and API entry points for the OpenFin Core API. Start here to develop OpenFin applications in TypeScript.

Libraries are also available for the following frameworks:

• Node.js
• .Net
• Java

Prerequsites

None.

Installation

This package cannot be installed as a dev dependency because it is not types-only.

With npm:

npm i -S @openfin/core

With yarn:

yarn add @openfin/core

Usage

The fin export is the primary API entry point. Type definitions are defined in the package's default export.

The static fin.me object contains some information about the current runtime environment even if imported outside of an OpenFin setting. In this case, the isOpenFin property of fin.me will be false. Outside of OpenFin environments, OpenFin API calls will nullop and throw an error.

import OpenFin, { fin } from "@openfin/core"; 

const showWindow = async (identity: OpenFin.Identity) => {
   const win = await fin.Window.wrap(identity);
   await win.show();

const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
}

For more information

• Developer guide
• API reference

License

Copyright 2020-2022 OpenFin

The code in this package is distributed under the Apache License, Version 2.0.

However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or email us at [e-mail] with questions.

• Licensing
• Developer agreement