Installation
npm install --save @types/koji-tools
Summary
This package contains type definitions for koji-tools (https://github.com/madewithkoji/koji-tools).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koji-tools.
index.d.ts
/**
* Server-side function that sets file watchers on all .koji customization
* files and allows for hot reloading of these properties.
*/
export function watch(): void;
/**
* Sets up Koji.config parameters for each client and handles communication
* between the Koji live preview iframe and your app.
*/
export function pageLoad(options?: object): void;
/**
* Wrapper for fetch that takes objects from Koji.routes.
*/
export function request(route: object, params?: object): Promise<any>;
/**
* After the 'pwaPromptReady' event has fired, this function will make a popup
* installation prompt appear.
*/
export function pwaPrompt(): any;
/**
* An auto-generated list of all of the Koji Customization Controls (VCCs) your
* application has setup. When Koji.watch() is being used this list updates automatically.
*/
export const config: object;
/**
* A auto-generated list of routes based on koji.json files in your project that are
* used in Koji.request() to request the backend of your app.
*/
export const routes: object;
export const pwa: any;
/**
* Registers a callback on a Koji event.
* @param event name of the event being called
* @param callback method to execute when the event occurs
*/
export function on(event: string, callback: () => void): void;
/**
* Resolve the value of a user's secret from the Koji Keystore. Secrets are used for
* values that are not intended to be read by other users when a project is remixed.
*/
export function resolveSecret(key: string): string | null;Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:38 GMT
- Dependencies: none
Credits
These definitions were written by Jeff Peterson.