@benjosivo/mysql 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -36
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,46 +4,10 @@ Shared MySQL client (pooling, automatic retry on deadlock/lock-timeout, transact
|
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
|
-
This package is published to **GitHub Packages**, not the public npm registry, so every machine needs a one-time setup before `npm install` will work — even though the repo and package are public. GitHub Packages never allows anonymous installs; a valid GitHub token is always required.
|
|
8
|
-
|
|
9
|
-
### One-time setup (per machine)
|
|
10
|
-
|
|
11
|
-
1. **Create a GitHub Personal Access Token.**
|
|
12
|
-
GitHub → click your avatar → **Settings** → **Developer settings** → **Personal access tokens** → **Tokens (classic)** → **Generate new token (classic)**.
|
|
13
|
-
Scope needed: **`read:packages`**. Copy the token — GitHub only shows it once.
|
|
14
|
-
|
|
15
|
-
2. **Add two lines to your global npm config.**
|
|
16
|
-
Find the file path:
|
|
17
|
-
```
|
|
18
|
-
npm config get globalconfig
|
|
19
|
-
```
|
|
20
|
-
It's typically `C:\Users\<you>\AppData\Roaming\npm\etc\npmrc` on Windows. Open that file in a text editor and add:
|
|
21
|
-
```
|
|
22
|
-
@benjosivo:registry=https://npm.pkg.github.com
|
|
23
|
-
//npm.pkg.github.com/:_authToken=YOUR_TOKEN_HERE
|
|
24
|
-
```
|
|
25
|
-
Editing the file directly is more reliable than `npm config set` — on some npm versions, `npm config set @benjosivo:registry=... --global` fails with a cryptic `` `` is not a valid npm option `` error. If you'd rather use the CLI, use the space-separated form instead of `=`:
|
|
26
|
-
```
|
|
27
|
-
npm config set @benjosivo:registry https://npm.pkg.github.com --global
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
3. **Verify both lines took effect:**
|
|
31
|
-
```
|
|
32
|
-
npm config list
|
|
33
|
-
```
|
|
34
|
-
You should see both `@benjosivo:registry = "https://npm.pkg.github.com"` and `//npm.pkg.github.com/:_authToken = (protected)` in the output.
|
|
35
|
-
|
|
36
|
-
### Install
|
|
37
|
-
|
|
38
7
|
```
|
|
39
8
|
npm install @benjosivo/mysql
|
|
40
9
|
```
|
|
41
10
|
|
|
42
|
-
### Troubleshooting
|
|
43
|
-
|
|
44
|
-
- **`404 Not Found - GET https://registry.npmjs.org/@benjosivo%2fmysql`** — npm is checking the default npm registry instead of GitHub Packages. This means the `@benjosivo:registry` line from step 2 above isn't set (check with `npm config get @benjosivo:registry`). Add it and retry.
|
|
45
|
-
- **401/403 or `ENEEDAUTH`** — the auth token is missing, expired, or lacks `read:packages` scope. Regenerate a token and re-add it.
|
|
46
|
-
|
|
47
11
|
## Usage
|
|
48
12
|
|
|
49
13
|
```ts
|