This repository has been archived by the owner on Oct 18, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Add typescript declaration #24
Open
frontsideair
wants to merge
1
commit into
master
Choose a base branch
from
types
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,34 @@ | ||
import express, { Express } from "express"; | ||
import Keyv from "keyv"; | ||
import { Tgl, middleware, router, Toggle } from "tgl"; | ||
|
||
const toggles: Toggle[] = [ | ||
{ | ||
name: "universal", | ||
description: "Do we address the world, or the whole universe?", | ||
defaultValue: false | ||
}, | ||
{ | ||
name: "lasers", | ||
description: "Enable lasers!!!", | ||
defaultValue: true | ||
} | ||
]; | ||
const storage: Keyv<boolean> = new Keyv(); | ||
const tgl: Tgl = new Tgl({ toggles, storage }); | ||
|
||
tgl.get("hello"); | ||
tgl.set("hello", true); | ||
|
||
const app: Express = express(); | ||
|
||
app.use(middleware(tgl)); | ||
|
||
app.get("/", (req, res) => { | ||
const universal = req.tgl.get("universal"); | ||
res.send(universal ? "Hello, universe!" : "Hello, world!"); | ||
}); | ||
|
||
app.use("/tgl", router(tgl)); | ||
|
||
module.exports = app; |
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,40 @@ | ||
declare namespace Express { | ||
interface Request extends TglRequest {} | ||
} | ||
|
||
declare interface TglRequest { | ||
tgl?: Tgl; | ||
} | ||
|
||
declare module "tgl" { | ||
import express from "express"; | ||
import Keyv from "keyv"; | ||
|
||
export interface Toggle { | ||
name: string; | ||
description: string; | ||
defaultValue: boolean; | ||
} | ||
|
||
export function middleware(tgl: Tgl): express.Handler; | ||
|
||
export function router(tgl: Tgl): express.Router; | ||
|
||
export class Tgl { | ||
constructor({ | ||
toggles, | ||
storage, | ||
interval | ||
}: { | ||
toggles: Toggle[]; | ||
storage: Keyv<boolean>; | ||
interval?: number; | ||
}); | ||
|
||
toggles: boolean[]; | ||
|
||
get(key: string): boolean; | ||
|
||
set(key: string, value: boolean): Promise<void>; | ||
} | ||
} |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn’t work.