-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(typescript): Add typings for the module (#16)
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; |