Make sure the open source you're using is safe to use
hms-protocol
v1.2.3The protocol stream that hms uses to communicate between servers and clients
npm install hms-protocol
We couldn't find any similar packages Browse all packages
Package Health Score
37 / 100
- Popularity Limited
- Maintenance Inactive
- Security Security review needed
- Community Limited
Make sure the open source you're using is safe to usePopularity
Limited
Weekly Downloads (10)- Dependents
- 2
- GitHub Stars
- 3
- Forks
- 1
- Contributors
- 3
The npm package hms-protocol receives a total of 10 downloads a week. As such, we scored hms-protocol popularity level to be Limited.
Based on project statistics from the GitHub repository for the npm package hms-protocol, we found that it has been starred 3 times, and that 2 other projects in the ecosystem are dependent on it.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
Security
Security review needed
Security and license risk for significant versions
All VersionsDirect Vulnerabilities
0.1.1
0.2.1
0.3.0
1.1.0
1.2.3
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
Indirect Vulnerabilities
0.1.1
0.2.1
0.3.0
1.1.0
1.2.3
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
License Risks
0.1.1
0.2.1
0.3.0
1.1.0
1.2.3
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
All security vulnerabilities belong to
production dependencies of direct and indirect
packages.
Unable to detect license
We couldn’t find an appropriate license for this project. It is highly advised to make sure the project license is compatible with your business needs before including it as a dependency, to keep yourself protected from infringement suits or loss of your own code.
We found a way for you to contribute to the project! Looks like hms-protocol is missing a security policy.
You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.
We found a way for you to contribute to the project! Looks like hms-protocol is missing a security policy.
# Install the Snyk CLI and test your project
npm i snyk && snyk test hms-protocol
Maintenance
Inactive
Commit Frequency- Open Issues
- 0
- Merged PR
- 2
- Open PR
- 0
- Last Commit
- 6 years ago
Further analysis of the maintenance status of hms-protocol based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.
An important project maintenance signal to consider for hms-protocol is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.
In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.
Community
Limited
- Readme.md
- No
- Contributing.md
- No
- Code of Conduct
- No
- Contributors
- 3
- Funding
- Yes
This project has seen only 10 or less contributors.
We found a way for you to contribute to the project! Looks like hms-protocol is missing a Code of Conduct.
How about a good first contribution to this project? It seems that hms-protocol is missing a LICENSE file.
How about a good first contribution to this project? It seems that hms-protocol is missing a README file.
Embed Package Health Score Badge
Package
- Node.js Compatibility
- not defined
- Age
- 7 years
- Dependencies
- 1 Direct / 1 Total
- Versions
- 12
- Install Size
- 0 B
- Dist-tags
- 1
- # of Files
- 0
- Maintainers
- 2
- TS Typings
- No
We detected a total of 1 direct & transitive dependencies for hms-protocol. See the full dependency tree of hms-protocol
hms-protocol has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
hms-protocol
The protocol stream that hms uses to communicate between servers and clients
npm install hms-protocol
This is mostly only useful for hms
Usage
Simply pipe the stream to and from a source
var protocol = require('hms-protocol');
var net = require('net');
net.createServer(function(stream) {
var p = protocol();
stream.pipe(p).pipe(stream);
p.on('start', function(id, cb) {
console.log('we received a start for', id);
cb();
});
}).listen(10000, function() {
var p = protocol();
var stream = net.connect(10000);
stream.pipe(p).pipe(stream);
p.start('test', function(err) {
console.log('start was received?', err);
});
});
Send messages
The following messages are supported over the protocol
p.handshake(opts, cb)send a protocol handhakep.ping(cb)ping to see if remote is alivep.get(id, cb)get information about a servicep.add(id, service, cb)add a new service.p.update(id, service, cb)update an existing servicep.remove(id, cb)remove a servicep.list(cb)list all servicesp.ps(cb)get process information about all servicesp.start(id, cb)start a servicep.stop(id, cb)stop a servicep.restart(id, cb)restart a servicep.sync(id, service, cb)sync service statep.subscribe([id], cb)subscribe to service events. omit theidto subscribe to*p.unsubscribe([id], cb)unsubscribe from service events. omit theidto unsubscribe*p.stdout(id, origin, buffer)send a stdout eventp.stderr(id, origin, buffer)send a stderr eventp.spawn(id, origin, pid)send a process spawn eventp.exit(id, origin, code)send a process exit eventp.amSubscribing(id)returns true if you are subscribing toidp.peerSubscribing(id)returns true if the peer is subscribing toid
The service message can contain the following
{
start: 'node .',
build: 'npm install',
docks: [
'dock-id-to-run-at'
],
env: {
FOO: 'bar'
}
}
Receive messages
Sending any of the above messages will trigger an event of the same for the receiver.
I.e. if you do p.start(id, cb) it will result in p.on('start', id, cb) being triggered
for the receiver
License
MIT
hms-protocol versions
| Version | Published | Tag | Node.js Compatability | Licenses | Dependencies | Direct Vulnerabilities | Publisher |
|---|---|---|---|---|---|---|---|
| 1.2.3 | 06 February 2015 | latest | * | 1 |
| gausby | |
| 1.1.0 | 08 April 2014 | * | 1 |
| mafintosh | ||
| 0.3.0 | 07 April 2014 | * | 1 |
| mafintosh | ||
| All Versions | |||||||
hms-protocol dependencies
Last updated on
15 January-2021, at 20:14 (UTC).