ametnisi

library1.3.0jsnpmunverified

A lightweight gRPC health check implementation using @grpc/grpc-js (v1.3.0). Provides a simple way to implement the standard gRPC health checking protocol for Node.js services. Compatible with gRPC health probes like Kubernetes liveness/readiness checks. Uses the stable @grpc/grpc-js library (not the deprecated grpc package). Release cadence is irregular; last update was 2 years ago.

devops

npm install ametnisi

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AMETNISI

ametnisi

devopsjavascriptv1.3.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

HealthCheckClient

✓ import { HealthCheckClient } from 'ametnisi'

✗ const { HealthCheckClient } = require('ametnisi')

ESM-only since v1.0; CommonJS require() will throw. Use ESM import.

HealthCheckServer

✓ import { HealthCheckServer } from 'ametnisi'

✗ import * as ametnisi from 'ametnisi'

Named export; not a namespace import. Use named import.

Types

✓ import type { HealthCheckStatus } from 'ametnisi'

✗ import { HealthCheckStatus } from 'ametnisi'

Use type import for type-only exports (TS). Runtime import will fail.

Creates a gRPC health check server on localhost:50051 and logs a message on start. Handles graceful shutdown on SIGINT.

import { HealthCheckServer } from 'ametnisi'; import { credentials } from '@grpc/grpc-js'; const server = new HealthCheckServer({ url: 'localhost:50051', credentials: credentials.createInsecure() }); server.start(() => { console.log('Health check server started'); }); process.on('SIGINT', () => { server.stop(() => process.exit(0)); });

Debug

Known issues

gotchaThe package uses @grpc/grpc-js as a peer dependency; ensure @grpc/grpc-js >=1.4.0 is installed.

fix

npm install @grpc/grpc-js@^1.4.0

affects: >=1.0.0

breakingIn v1.2.0, the HealthCheckClient constructor changed from (address, credentials) to ({ url, credentials }).

fix

Update instantiation: new HealthCheckClient({ url: 'localhost:50051', credentials: creds })

affects: >=1.2.0

deprecatedThe 'healthCheckStatus' export (lowercase) was deprecated in v1.1.0. Use 'HealthCheckStatus' (PascalCase) instead.

fix

Replace 'healthCheckStatus' with 'HealthCheckStatus'

affects: >=1.1.0 <2.0.0

Errors

Common errors & fixes

Error: Cannot find module '@grpc/grpc-js'

Missing peer dependency @grpc/grpc-js

fix

npm install @grpc/grpc-js

TypeError: server.start is not a function

Using CommonJS require() instead of ESM import()

fix

Use 'import { HealthCheckServer } from 'ametnisi'' instead of require()

Error: Invalid URL: 'localhost:50051'

Missing protocol in URL string (should be 'http://localhost:50051' or use object config)

fix

Use { url: 'http://localhost:50051' } or just 'localhost:50051' if using the object config

Upgrade

Version history

1.3.0latest on npm

Audit

Dependencies

@grpc/grpc-jsoptionalPeer dependency for gRPC client and server implementation

protobufjsrequiredRequired for protocol buffer message handling

Agent activity

30 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/NicholeReilly/ametnisi ↗

packageametnisi ↗

homepagehttps://github.com/NicholeReilly/ametnisi.git ↗