@types/finch

TypeScript definitions for Finch

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
34,956811Jul 25, 2021Oct 5, 2012Minified + gzip package size for @types/finch in KB

Readme

Installation

npm install --save @types/finch

Summary

This package contains type definitions for Finch (https://github.com/stoodder/finchjs).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/finch.

index.d.ts

// Type definitions for Finch 0.5.13
// Project: https://github.com/stoodder/finchjs
// Definitions by: David Sichau <https://github.com/DavidSichau>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped


interface FinchCallback {
    (bindings?: any, childCallback? : () => void): any;
}

interface ExpandedCallback {
    setup?: FinchCallback | undefined;
    load?: FinchCallback | undefined;
    unload?: FinchCallback | undefined;
    teardown?: FinchCallback | undefined;
}

interface ObserveCallback {
    (...args: any[]): string;
}
interface FinchOptions {
    CoerceParameterTypes?: boolean | undefined;
}


interface FinchStatic {
    route(route: string, callback: FinchCallback): void;
    route(route: string, callbacks: ExpandedCallback): void;
    call( uri: string ): void;

    observe(argN: string[], callback: (params: ObserveCallback ) => void): void;
    observe(callback: (params: ObserveCallback) => void): void;
    observe(...args: any[]): void;
    navigate(uri:string, queryParams?:any, doUpdate?:boolean ): void;
    navigate(uri:string, doUpdate:boolean ): void;
    navigate(queryParams:any, doUpdate?:boolean ): void;
    listen(): boolean;
    ignore(): boolean;
    abort(): void;
    options(options: FinchOptions): void;
}


declare var Finch: FinchStatic;
declare module "finch" {
    export = Finch;
}

Additional Details

  • Last updated: Thu, 08 Jul 2021 12:01:36 GMT
  • Dependencies: none
  • Global values: Finch

Credits

These definitions were written by David Sichau.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.