Skip to content

Commit

Permalink
docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Jun 26, 2016
1 parent bbdafc0 commit e43c87f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
21 changes: 18 additions & 3 deletions typescript/README.md
Expand Up @@ -2,12 +2,27 @@

Complete TypeScript ambient declarations for [spex] version 1.0.7 or later.

#### Installing
#### Inclusion

Since all TypeScript files are distributed with the library, you can reference it like this:

```ts
/// <reference path='../node_modules/spex/typescript/spex' />
```

Or you can installing using [Typings]:

```
typings install --save --global github:vitaly-t/spex
$ typings install --save --global github:vitaly-t/spex
```

Then you can use the generic reference:

```ts
/// <reference path='../typings/index' />
```


#### Usage

```ts
Expand All @@ -27,5 +42,5 @@ spex.batch([1, 2, 3])
});
```

[Typings]:https://github.com/typings/typings
[spex]:https://github.com/vitaly-t/spex

1 change: 1 addition & 0 deletions typescript/spex.d.ts
Expand Up @@ -108,6 +108,7 @@ declare module "spex" {
constructor(create:(cb:any)=>Object, resolve:(data:any)=>void, reject:(reason:any)=>void);
}

// Subset of the base methods only, to be used by pg-promise
interface ISpexBase {

// API: http://vitaly-t.github.io/spex/global.html#batch
Expand Down

0 comments on commit e43c87f

Please sign in to comment.