Deepgram JavaScript SDK 使用教程

Deepgram JavaScript SDK 使用教程

deepgram-js-sdkOfficial JavaScript SDK for Deepgram's automated speech recognition APIs.项目地址:https://gitcode.com/gh_mirrors/de/deepgram-js-sdk

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

Deepgram JavaScript SDK 的目录结构如下：

deepgram-js-sdk/
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── commitlint.config.js
├── dockerignore
├── eslintignore
├── eslintrc.js
├── gitignore
├── npmignore
├── package-lock.json
├── package.json
├── prettierignore
├── prettierrc
├── releaserc.json
├── src/
│   ├── index.js
│   └── ...
├── test/
│   └── ...
├── examples/
│   └── ...
├── tsconfig.json
├── tsconfig.module.json
└── webpack.config.js

目录介绍

• CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md: 社区行为准则、贡献指南和安全政策文档。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• commitlint.config.js: 提交信息规范配置文件。
• dockerignore, eslintignore, gitignore, npmignore, prettierignore: 各种忽略文件配置。
• eslintrc.js, prettierrc: 代码风格和格式化配置文件。
• package-lock.json, package.json: npm 包管理文件。
• src/: 源代码目录。
• test/: 测试代码目录。
• examples/: 示例代码目录。
• tsconfig.json, tsconfig.module.json: TypeScript 配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的入口文件是 src/index.js，它负责导出 SDK 的主要功能和接口。

// src/index.js
export { createClient } from './client';
// 其他导出内容

启动文件介绍

• src/index.js: 项目的入口文件，导出 SDK 的主要功能和接口。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖信息。

{
  "name": "@deepgram/sdk",
  "version": "1.0.0",
  "description": "Official JavaScript SDK for Deepgram's automated speech recognition APIs",
  "main": "src/index.js",
  "scripts": {
    "build": "webpack",
    "test": "jest"
  },
  "dependencies": {
    "axios": "^0.21.1"
  },
  "devDependencies": {
    "jest": "^26.6.3",
    "webpack": "^5.24.2",
    "webpack-cli": "^4.5.0"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true
  },
  "include": ["src/**/*"]
}

webpack.config.js

webpack.config.js 文件是 Webpack 的配置文件，定义了打包选项。

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'deepgram-sdk.js',
    library: 'DeepgramSDK',
    libraryTarget: 'umd'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  }
};

通过以上配置文件，可以对项目进行编译、打包和测试。

deepgram-js-sdkOfficial JavaScript SDK for Deepgram's automated speech recognition APIs.项目地址:https://gitcode.com/gh_mirrors/de/deepgram-js-sdk