From 8e29f27ec47a06db246e857cb6669589a36308b4 Mon Sep 17 00:00:00 2001 From: dvalenti314 Date: Tue, 11 Apr 2017 21:42:01 -0500 Subject: [PATCH 1/3] added readme to angular-hotkeys --- types/angular-hotkeys/README.md | 55 ++++++++++++++++++++++++++++++++ types/angular-hotkeys/index.d.ts | 1 + 2 files changed, 56 insertions(+) create mode 100644 types/angular-hotkeys/README.md diff --git a/types/angular-hotkeys/README.md b/types/angular-hotkeys/README.md new file mode 100644 index 0000000000..8184740665 --- /dev/null +++ b/types/angular-hotkeys/README.md @@ -0,0 +1,55 @@ +## What is it? + +This is a typescript interface to be used with [angular-hotkeys](https://github.com/chieffancypants/angular-hotkeys/). + +## What are declaration files? + +See the [TypeScript handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html). + + +## How do I get them? + +### npm + +This is the preferred method. This is only available for TypeScript 2.0+ users. For these typeings: + +```sh +npm install --save-dev @types/angular-hotkeys +``` + +The types should then be automatically included by the compiler. +See more in the [handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html). + + +### Other methods + +These can be used by TypeScript 1.0. + +* [Typings](https://github.com/typings/typings) +* ~~[NuGet](http://nuget.org/Tpackages?q=DefinitelyTyped)~~ (use preferred alternatives, nuget DT type publishing has been turned off) +* Manually download from the `master` branch of this repository + +You may need to add manual [references](http://www.typescriptlang.org/docs/handbook/triple-slash-directives.html). + +## How to use + +After installing a package you can import the definition file and begin using it as so: + +```ts + +import * as hotkeys from '../../node_modules/@types/angular-hotkeys' + +class FooController { + static $inject = [ + 'hotkeys' + ]; + + constructor( + private hotkeys: ng.hotkeys.HotkeysProvider + ) { } +} + +``` + +for a detailed explanation of the behavior of angular-hotkeys please refer to [its documentation](https://github.com/chieffancypants/angular-hotkeys/) + diff --git a/types/angular-hotkeys/index.d.ts b/types/angular-hotkeys/index.d.ts index f37171c416..5287eef25d 100644 --- a/types/angular-hotkeys/index.d.ts +++ b/types/angular-hotkeys/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/chieffancypants/angular-hotkeys // Definitions by: Jason Zhao , Stefan Steinhart // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +//readme written by David Valentine /// From ed943d7b2b1d0bd0ee49661997f31d90e6e6fb54 Mon Sep 17 00:00:00 2001 From: dvalenti314 Date: Tue, 11 Apr 2017 21:42:01 -0500 Subject: [PATCH 2/3] added readme to angular-hotkeys --- types/angular-hotkeys/README.md | 55 ++++++++++++++++++++++++++++++++ types/angular-hotkeys/index.d.ts | 1 + 2 files changed, 56 insertions(+) create mode 100644 types/angular-hotkeys/README.md diff --git a/types/angular-hotkeys/README.md b/types/angular-hotkeys/README.md new file mode 100644 index 0000000000..8184740665 --- /dev/null +++ b/types/angular-hotkeys/README.md @@ -0,0 +1,55 @@ +## What is it? + +This is a typescript interface to be used with [angular-hotkeys](https://github.com/chieffancypants/angular-hotkeys/). + +## What are declaration files? + +See the [TypeScript handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html). + + +## How do I get them? + +### npm + +This is the preferred method. This is only available for TypeScript 2.0+ users. For these typeings: + +```sh +npm install --save-dev @types/angular-hotkeys +``` + +The types should then be automatically included by the compiler. +See more in the [handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html). + + +### Other methods + +These can be used by TypeScript 1.0. + +* [Typings](https://github.com/typings/typings) +* ~~[NuGet](http://nuget.org/Tpackages?q=DefinitelyTyped)~~ (use preferred alternatives, nuget DT type publishing has been turned off) +* Manually download from the `master` branch of this repository + +You may need to add manual [references](http://www.typescriptlang.org/docs/handbook/triple-slash-directives.html). + +## How to use + +After installing a package you can import the definition file and begin using it as so: + +```ts + +import * as hotkeys from '../../node_modules/@types/angular-hotkeys' + +class FooController { + static $inject = [ + 'hotkeys' + ]; + + constructor( + private hotkeys: ng.hotkeys.HotkeysProvider + ) { } +} + +``` + +for a detailed explanation of the behavior of angular-hotkeys please refer to [its documentation](https://github.com/chieffancypants/angular-hotkeys/) + diff --git a/types/angular-hotkeys/index.d.ts b/types/angular-hotkeys/index.d.ts index f37171c416..d0340d5826 100644 --- a/types/angular-hotkeys/index.d.ts +++ b/types/angular-hotkeys/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/chieffancypants/angular-hotkeys // Definitions by: Jason Zhao , Stefan Steinhart // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +//readme written by David Valentine /// From 428a0bfed9ddc0025c637b9b60a79af434fea39d Mon Sep 17 00:00:00 2001 From: dvalenti314 Date: Fri, 14 Apr 2017 16:22:35 -0500 Subject: [PATCH 3/3] Update README.md --- types/angular-hotkeys/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/angular-hotkeys/README.md b/types/angular-hotkeys/README.md index 8184740665..a31ed8a936 100644 --- a/types/angular-hotkeys/README.md +++ b/types/angular-hotkeys/README.md @@ -11,7 +11,7 @@ See the [TypeScript handbook](http://www.typescriptlang.org/docs/handbook/declar ### npm -This is the preferred method. This is only available for TypeScript 2.0+ users. For these typeings: +This is the preferred method. This is only available for TypeScript 2.0+ users. For these typings: ```sh npm install --save-dev @types/angular-hotkeys