mirror of
https://github.com/nodejs/node.git
synced 2025-05-14 18:26:05 +00:00
dc05c70c8f
PR-URL: https://github.com/nodejs/node/pull/35908 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Guy Bedford <guybedford@gmail.com>
87 lines
1.8 KiB
Markdown
87 lines
1.8 KiB
Markdown
---
|
|
title: npm-hook
|
|
section: 1
|
|
description: Manage registry hooks
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm hook ls [pkg]
|
|
npm hook add <entity> <url> <secret>
|
|
npm hook update <id> <url> [secret]
|
|
npm hook rm <id>
|
|
```
|
|
|
|
### Description
|
|
|
|
Allows you to manage [npm
|
|
hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
|
|
including adding, removing, listing, and updating.
|
|
|
|
Hooks allow you to configure URL endpoints that will be notified whenever a
|
|
change happens to any of the supported entity types. Three different types
|
|
of entities can be watched by hooks: packages, owners, and scopes.
|
|
|
|
To create a package hook, simply reference the package name.
|
|
|
|
To create an owner hook, prefix the owner name with `~` (as in,
|
|
`~youruser`).
|
|
|
|
To create a scope hook, prefix the scope name with `@` (as in,
|
|
`@yourscope`).
|
|
|
|
The hook `id` used by `update` and `rm` are the IDs listed in `npm hook ls`
|
|
for that particular hook.
|
|
|
|
The shared secret will be sent along to the URL endpoint so you can verify
|
|
the request came from your own configured hook.
|
|
|
|
### Example
|
|
|
|
Add a hook to watch a package for changes:
|
|
|
|
```bash
|
|
$ npm hook add lodash https://example.com/ my-shared-secret
|
|
```
|
|
|
|
Add a hook to watch packages belonging to the user `substack`:
|
|
|
|
```bash
|
|
$ npm hook add ~substack https://example.com/ my-shared-secret
|
|
```
|
|
|
|
Add a hook to watch packages in the scope `@npm`
|
|
|
|
```bash
|
|
$ npm hook add @npm https://example.com/ my-shared-secret
|
|
```
|
|
|
|
List all your active hooks:
|
|
|
|
```bash
|
|
$ npm hook ls
|
|
```
|
|
|
|
List your active hooks for the `lodash` package:
|
|
|
|
```bash
|
|
$ npm hook ls lodash
|
|
```
|
|
|
|
Update an existing hook's url:
|
|
|
|
```bash
|
|
$ npm hook update id-deadbeef https://my-new-website.here/
|
|
```
|
|
|
|
Remove a hook:
|
|
|
|
```bash
|
|
$ npm hook rm id-deadbeef
|
|
```
|
|
|
|
### See Also
|
|
|
|
* ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)
|