Skip to content

Commit 8a05b84

Browse files
committed
feat(types): add TypeScript declarations
fix #1
1 parent eac7556 commit 8a05b84

24 files changed

Lines changed: 4576 additions & 4645 deletions

.codeclimate.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,3 @@ engines:
88
ratings:
99
paths:
1010
- "src/*.js"
11-
## Exclude test files.
12-
exclude_patterns:
13-
- "dist/"
14-
- "**/node_modules/"
15-
- "src/*.test.js"

.eslintrc.js

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/CODE_OF_CONDUCT.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Code of Conduct
22

3-
Be kind, except if i behave like an asshole,
4-
if so, tell me by linking to this file.
3+
Be kind, except if I behave like an asshole, if so, tell me by linking to this
4+
file.
55

6-
I try hard to automate things so that you cannot
7-
create noises without really willing to do so.
6+
I try hard to document and automate things so that you cannot create noises
7+
without really willing to do so.
88

9-
This is why i'll just delete issues/comments
10-
making be sad.
9+
This is why I'll just delete issues/comments making be sad.

.github/CONTRIBUTING

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Contributing to this project requires you to be
22
a gentleman.
33

44
By contributing you must agree with publishing your
5-
changes int the same license than the actual code.
5+
changes into the same license that apply to the current code.
66

77
You will find the license in the LICENSE file at
88
the root of this repository.

.github/ISSUE_TEMPLATE

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Before doing so, there are a few checks to do in
1010
Beware that you also can create a pull request
1111
if you know how to solve the issue.
1212

13-
Finally scroll down if you asking for a feature ;)
13+
Finally scroll down if you are asking for a new feature ;)
1414

1515
-->
1616

17-
I'm a gentledev i:
17+
I'm a gentledev I:
1818
- [ ] fully read the README recently
1919
- [ ] searched for existing issues
20-
- [ ] checked i'm up to date with the latest version of the project
20+
- [ ] checked I'm up to date with the latest version of the project
2121

2222
### Expected behavior
2323

@@ -35,16 +35,16 @@ I'm a gentledev i:
3535
```
3636
<paste here>
3737
```
38-
If the result is lower than 6.9.5, there is
39-
poor chances i even have a look to it. Please,
38+
If the result is lower than 8.12.0, there is
39+
poor chances I even have a look to it. Please,
4040
use the last [NodeJS LTS version](https://nodejs.org/en/).
4141

4242
## Feature request
4343
<!--
4444

4545
If you think a feature need to be added, your suggestions
4646
are welcome. Beware though that:
47-
- I try to keep my module simple so please ensure the requested
47+
- I try to keep my modules simple so please ensure the requested
4848
feature is really related to this module. If not, you may
4949
instead create a module that augment/work with this one,
5050
- I am not your employee so keep calm and be aware that your
@@ -56,4 +56,4 @@ If you think a feature need to be added, your suggestions
5656

5757
### Use cases
5858

59-
- [ ] I will/have implement the feature
59+
- [ ] I will/did implement the feature

.github/PULL_REQUEST_TEMPLATE

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Fixes #
2020
- [ ] I made some tests for my changes
2121
- [ ] I added my name in the
2222
[contributors](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
23-
field of the package.json file
23+
field of the `package.json` file. Beware to use the same format than for the author field
24+
for the entries so that you'll get a mention in the `README.md` with a link to your website.
2425

2526
### License
2627
To get your contribution merged, you must check the following.
@@ -34,9 +35,9 @@ If you already maintain several NPM modules / NodeJS
3435
project, making significant changes on one of my modules
3536
automatically legitimates you as a core developer.
3637

37-
This is because i could die or even not give a shit to
38-
this project someday and i don't want people to get
39-
stuck.
38+
This is because I could die or even not give a shit to
39+
this project someday and I don't want people to get
40+
stuck in such cases.
4041

4142
If you want to help, fill the following with to get
4243
GitHub/NPM r/w access.

.gitignore

Lines changed: 89 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,36 @@
22
# module. Do not change it elsewhere, changes would
33
# be overridden.
44

5+
# Created by https://www.gitignore.io/api/osx,node,linux
6+
7+
### Linux ###
8+
*~
9+
10+
# temporary files which can be created if a process still has a handle open of a deleted file
11+
.fuse_hidden*
12+
13+
# KDE directory preferences
14+
.directory
15+
16+
# Linux trash folder which might appear on any partition or disk
17+
.Trash-*
18+
19+
# .nfs files are created when an open file is removed but is still being accessed
20+
.nfs*
21+
22+
### Node ###
523
# Logs
624
logs
725
*.log
826
npm-debug.log*
27+
yarn-debug.log*
28+
yarn-error.log*
929

1030
# Runtime data
1131
pids
1232
*.pid
1333
*.seed
34+
*.pid.lock
1435

1536
# Directory for instrumented libs generated by jscoverage/JSCover
1637
lib-cov
@@ -21,25 +42,89 @@ coverage
2142
# nyc test coverage
2243
.nyc_output
2344

24-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
45+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
2546
.grunt
2647

48+
# Bower dependency directory (https://bower.io/)
49+
bower_components
50+
2751
# node-waf configuration
2852
.lock-wscript
2953

30-
# Compiled binary addons (http://nodejs.org/api/addons.html)
54+
# Compiled binary addons (https://nodejs.org/api/addons.html)
3155
build/Release
3256

3357
# Dependency directories
34-
node_modules
35-
jspm_packages
58+
node_modules/
59+
jspm_packages/
60+
61+
# TypeScript v1 declaration files
62+
typings/
3663

3764
# Optional npm cache directory
3865
.npm
3966

67+
# Optional eslint cache
68+
.eslintcache
69+
4070
# Optional REPL history
4171
.node_repl_history
4272

73+
# Output of 'npm pack'
74+
*.tgz
75+
76+
# Yarn Integrity file
77+
.yarn-integrity
78+
79+
# dotenv environment variables file
80+
.env
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
85+
# next.js build output
86+
.next
87+
88+
# nuxt.js build output
89+
.nuxt
90+
91+
# vuepress build output
92+
.vuepress/dist
93+
94+
# Serverless directories
95+
.serverless
96+
97+
### OSX ###
98+
# General
99+
.DS_Store
100+
.AppleDouble
101+
.LSOverride
102+
103+
# Icon must end with two \r
104+
Icon
105+
106+
# Thumbnails
107+
._*
108+
109+
# Files that might appear in the root of a volume
110+
.DocumentRevisions-V100
111+
.fseventsd
112+
.Spotlight-V100
113+
.TemporaryItems
114+
.Trashes
115+
.VolumeIcon.icns
116+
.com.apple.timemachine.donotpresent
117+
118+
# Directories potentially created on remote AFP share
119+
.AppleDB
120+
.AppleDesktop
121+
Network Trash Folder
122+
Temporary Items
123+
.apdisk
124+
125+
126+
# End of https://www.gitignore.io/api/osx,node,linux
127+
43128
# Coveralls key
44129
.coveralls.yml
45130

.prettierrc.js

Lines changed: 0 additions & 7 deletions
This file was deleted.

.travis.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44

55
language: node_js
66
node_js:
7-
- 6
8-
- 6.9.5
9-
- 7
107
- 8
8+
- 8.12.0
119
- 9
1210
- 10

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
# postgresql-service
88
> A simple wrapper around `node-pg`
99
10-
[![NPM version](https://badge.fury.io/js/postgresql-service.svg)](https://npmjs.org/package/postgresql-service)
10+
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/postgresql-service/blob/master/LICENSE)
1111
[![Build status](https://secure.travis-ci.org/nfroidure/postgresql-service.svg)](https://travis-ci.org/nfroidure/postgresql-service)
12+
[![Coverage Status](https://coveralls.io/repos/nfroidure/postgresql-service/badge.svg?branch=master)](https://coveralls.io/r/nfroidure/postgresql-service?branch=master)
13+
[![NPM version](https://badge.fury.io/js/postgresql-service.svg)](https://npmjs.org/package/postgresql-service)
1214
[![Dependency Status](https://david-dm.org/nfroidure/postgresql-service.svg)](https://david-dm.org/nfroidure/postgresql-service)
1315
[![devDependency Status](https://david-dm.org/nfroidure/postgresql-service/dev-status.svg)](https://david-dm.org/nfroidure/postgresql-service#info=devDependencies)
14-
[![Coverage Status](https://coveralls.io/repos/nfroidure/postgresql-service/badge.svg?branch=master)](https://coveralls.io/r/nfroidure/postgresql-service?branch=master)
15-
[![Code Climate](https://codeclimate.com/github/nfroidure/postgresql-service.svg)](https://codeclimate.com/github/nfroidure/postgresql-service)
16-
[![Dependency Status](https://dependencyci.com/github/nfroidure/postgresql-service/badge)](https://dependencyci.com/github/nfroidure/postgresql-service)
1716
[![Package Quality](http://npm.packagequality.com/shield/postgresql-service.svg)](http://packagequality.com/#?package=postgresql-service)
17+
[![Code Climate](https://codeclimate.com/github/nfroidure/postgresql-service.svg)](https://codeclimate.com/github/nfroidure/postgresql-service)
1818

1919

2020
[//]: # (::contents:start)

0 commit comments

Comments
 (0)