Skip to content

Commit

Permalink
feat(typescript): Add typings for the module (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfy1339 authored and gr2m committed Jan 29, 2019
1 parent c9de3a0 commit 6dbc4c0
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import LRU = require("lru-cache");

declare interface AppOptions {
id: string
privateKey: string
baseUrl?: string
cache?: LRU.Cache<string, string>
}

declare interface getInstallationAccessTokenOptions {
installation_id: number
}

// Not really a class, but it is how they say it should be used in the readme.
// In TypeScript, you cannot use the `new` keyword on functions (excluding old-style classes using functions and prototype), only on classes
declare class App {
constructor(options: AppOptions)
public getSignedJsonWebToken(): string
public getInstallationAccessToken(options?: getInstallationAccessTokenOptions): Promise<string>
}

export = App;

0 comments on commit 6dbc4c0

Please sign in to comment.