Skip to content

Commit

Permalink
fix #53 readme links to constructor properties are broken (#54)
Browse files Browse the repository at this point in the history
* Fix #53 readme links to constructor properties are broken
  • Loading branch information
regevbr authored Oct 28, 2019
1 parent c1a2a3e commit a054025
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
4 changes: 3 additions & 1 deletion .nycrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"extends": "@istanbuljs/nyc-config-typescript",
"exclude": ["src/test/**"]
"exclude": ["src/test/**"],
"sourceMap": true,
"produce-source-map": true
}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Npm Version](https://img.shields.io/npm/v/squiss-ts.svg?style=popout)](https://www.npmjs.com/package/squiss-ts)
[![Build Status](https://travis-ci.org/PruvoNet/squiss-ts.svg?branch=master)](https://travis-ci.org/PruvoNet/squiss-ts)
[![Build Status](https://travis-ci.com/PruvoNet/squiss-ts.svg?branch=master)](https://travis-ci.com/PruvoNet/squiss-ts)
[![Test Coverage](https://api.codeclimate.com/v1/badges/64f26f52c548c8d1e010/test_coverage)](https://codeclimate.com/github/PruvoNet/squiss-ts/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/64f26f52c548c8d1e010/maintainability)](https://codeclimate.com/github/PruvoNet/squiss-ts/maintainability)
[![Known Vulnerabilities](https://snyk.io/test/github/PruvoNet/squiss-ts/badge.svg?targetFile=package.json)](https://snyk.io/test/github/PruvoNet/squiss-ts?targetFile=package.json)
Expand Down Expand Up @@ -74,11 +74,11 @@ npm install squiss-ts

## How it works
Squiss processes as many messages simultaneously as possible.
Set the [maxInFlight](#squiss-class-constructor-options-polling-options-maxinflight) option to the number of messages your app can handle at one time without choking, and Squiss will keep
Set the [maxInFlight](https://squiss-ts.pruvo.com/#squiss-class-constructor-options-polling-options-maxinflight) option to the number of messages your app can handle at one time without choking, and Squiss will keep
that many messages flowing through your app, grabbing more as you mark each message as handled or ready for deletion.
If the queue is empty, Squiss will maintain an open connection to SQS, waiting for any messages that appear in real time.
Squiss can also handle renewing the visibility timeout for your messages until you handle the message, or message handling time
(set up by you) has passed (see [autoExtendTimeout](#squiss-class-constructor-options-auto-extend-options-autoextendtimeout)).
(set up by you) has passed (see [autoExtendTimeout](https://squiss-ts.pruvo.com/#squiss-class-constructor-options-auto-extend-options-autoextendtimeout)).
Bonus: Squiss will also automatically handle the message attributes formatting and parsing when receiving and sending messages.

## Versions
Expand Down
18 changes: 9 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "squiss-ts",
"version": "4.0.7",
"version": "4.0.8",
"description": "High-volume SQS poller",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand All @@ -12,8 +12,8 @@
"build": "npm run lint && npm run buildDist",
"buildDist": "rm -rf dist/* && ./node_modules/.bin/tsc",
"test": "npm run lint && npm run mocha",
"mocha": "mocha --opts src/test/mocha.opts",
"cover": "nyc --reporter=lcov --reporter=text-summary npm run test",
"mocha": "node --preserve-symlinks -r source-map-support/register node_modules/mocha/bin/_mocha --opts src/test/mocha.opts",
"cover": "rm -rf coverage && nyc --reporter=lcov --reporter=text-summary npm run test",
"lint": "tslint -c tslint.json 'src/**/*.ts' 'test/**/*.ts'"
},
"repository": {
Expand Down Expand Up @@ -46,15 +46,15 @@
},
"homepage": "https://github.com/PruvoNet/squiss-ts#readme",
"dependencies": {
"aws-sdk": "^2.529.0",
"iltorb": "^2.4.3",
"aws-sdk": "^2.555.0",
"iltorb": "2.4.3",
"linked-list": "^2.1.0",
"ts-type-guards": "^0.6.1",
"uuid": "^3.3.3"
},
"devDependencies": {
"@istanbuljs/nyc-config-typescript": "^0.1.3",
"@types/chai": "^4.2.3",
"@types/chai": "^4.2.4",
"@types/chai-as-promised": "^7.1.2",
"@types/iltorb": "^2.3.0",
"@types/mocha": "^5.2.7",
Expand All @@ -65,14 +65,14 @@
"chai-as-promised": "^7.1.1",
"delay": "^4.3.0",
"dirty-chai": "^2.0.1",
"mocha": "^6.2.0",
"mocha": "^6.2.2",
"nyc": "^14.1.1",
"proxyquire": "^2.1.3",
"sinon": "^7.4.2",
"sinon": "^7.5.0",
"sinon-chai": "^3.3.0",
"source-map-support": "^0.5.13",
"ts-node": "^8.4.1",
"tslint": "^5.20.0",
"typescript": "^3.6.3"
"typescript": "^3.6.4"
}
}
2 changes: 1 addition & 1 deletion src/test/src/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ describe('index', () => {
});
inst!.once('queueEmpty', spy);
inst!.start();
return wait().then(() => {
return wait(40).then(() => {
spy.should.be.calledOnce();
batches.should.deep.equal([
{total: 10, num: 10},
Expand Down

0 comments on commit a054025

Please sign in to comment.