@automattic/vip-go-node-internal

VIP Node.js Internal Library

This package provides a centralized library of reusable code for internal Node.js applications on the WordPress VIP Platform.

Libraries

Libraries included in this package:

• acme: Various helpers for communicating with the ACME API, such as adding a new Let's Encrypt certificate on a domain, getting more information on an existing Let's Encrypt certificate or modifying an existing Let's Encrypt certificate.

• alerts: A centralized alerting library for your apps.

• audit: Shared utilities for dealing with visibility of audit log events.

• cache: Shared utilities for inspect and purge the cache of VIP sites.

• constants: A centralized constants library to keep container type, host type, and site type ID names parallel across all apps.

• domains: Various helpers for working with domains on VIP, such as determining if a domain is a placeholder domain and calculating the automatic www/naked domain alternative.

• goopApi: API to communicate with GOOP.

• logs: Shared utilities for format logs of VIP sites.

• retry: Helper function for retrying operations.

• sds: VIP Site Details Service API broker library.

• sleep: Sleep utility.

Usage

Please refer to each individual library documentation above.

Contributing

See CONTRIBUTING.md for details on development, testing, publishing, etc.