pg-listen 项目使用教程

pg-listen 项目使用教程

pg-listen📡 PostgreSQL LISTEN & NOTIFY for node.js that finally works.项目地址:https://gitcode.com/gh_mirrors/pg/pg-listen

1. 项目的目录结构及介绍

pg-listen 项目的目录结构相对简单，主要包含以下几个部分：

pg-listen/
├── src/
│   ├── index.ts
│   ├── client.ts
│   ├── connection.ts
│   ├── errors.ts
│   ├── logger.ts
│   ├── types.ts
│   └── utils.ts
├── test/
│   ├── client.test.ts
│   ├── connection.test.ts
│   └── utils.test.ts
├── .gitignore
├── .npmignore
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

目录结构介绍

• src/：包含项目的源代码文件。
  • index.ts：项目的入口文件。
  • client.ts：客户端实现文件。
  • connection.ts：数据库连接管理文件。
  • errors.ts：自定义错误处理文件。
  • logger.ts：日志记录文件。
  • types.ts：类型定义文件。
  • utils.ts：工具函数文件。
• test/：包含项目的测试文件。
  • client.test.ts：客户端测试文件。
  • connection.test.ts：连接管理测试文件。
  • utils.test.ts：工具函数测试文件。
• .gitignore：Git 忽略文件配置。
• .npmignore：NPM 忽略文件配置。
• package.json：项目依赖和脚本配置。
• README.md：项目说明文档。
• tsconfig.json：TypeScript 配置文件。
• yarn.lock：Yarn 锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它是整个项目的入口点。该文件主要负责初始化客户端并提供对外的接口。

src/index.ts 文件介绍

import { Client } from './client';

export { Client };
export * from './types';

• import { Client } from './client';：导入客户端实现。
• export { Client };：导出客户端类。
• export * from './types';：导出类型定义。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 tsconfig.json。

package.json 文件介绍

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "pg-listen",
  "version": "1.5.0",
  "description": "PostgreSQL LISTEN & NOTIFY that just works",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest",
    "lint": "eslint src test",
    "prepublishOnly": "npm run build"
  },
  "dependencies": {
    "pg": "^8.0.0",
    "debug": "^4.1.1"
  },
  "devDependencies": {
    "@types/jest": "^25.1.4",
    "@types/node": "^13.9.0",
    "eslint": "^6.8.0",
    "jest": "^25.1.0",
    "ts-jest": "^25.2.1",
    "typescript": "^3.8.3"
  },
  "keywords": [
    "postgres",
    "postgresql",
    "listen",
    "notify",
    "pubsub",
    "events"
  ],
  "author": "Andy Wermke <andy@dev.next-step-software.com>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/andywer/pg-listen.git"
  },
  "bugs": {
    "url": "https://github.com/andywer/pg-listen/issues"
  },
  "homepage": "https://github.com/andywer/pg-listen#read

pg-listen📡 PostgreSQL LISTEN & NOTIFY for node.js that finally works.项目地址:https://gitcode.com/gh_mirrors/pg/pg-listen