codecov GitHub all releases
中文 | API Document

• NetEase Electron IM SDK
  • Table of Contents
  • Introduction
  • Runtime Requirements
  • System Requirements
  • Supported Platforms
  • Installation
  • Build From Source
  • Quick Start
    • Initialize SDK
    • Login
    • Send Message

node-nim is a Node.js wrapper for the NetEase IM PC SDK, enabling you to utilize all of its features in your preferred frontend framework with native platform performance.
For comprehensive documentation, changelog, and technical support, please visit https://dev.yunxin.163.com/.

node-nim is an NPM package that can be installed using the npm install command.
It will automatically download the prebuilt binary file that fits your current platform.

npm install node-nim

Maybe you need to build ia32 app on x64 platform or something like that, you can use --arch and --platform to specify the platform you want to build.

• Windows x64

npm install node-nim --arch=x64 --platform=win32

• Windows x86

npm install node-nim --arch=ia32 --platform=win32

• macOS x64

npm install node-nim --arch=x64 --platform=darwin

• macOS arm64

npm install node-nim --arch=arm64 --platform=darwin

• Linux x64

npm install node-nim --arch=x64 --platform=linux

• Linux arm64

npm install node-nim --arch=arm64 --platform=linux

Technically, native NIM SDK is shipped with a prebuilt node-nim.node binary file, so there is no need to build it yourself..
But if you want to add personal features or simply prefer to do so, feel free to build it!
Build Requirements:

• Node.js
• npm
• CMake
• CMake supported generator(Unix Makefiles, Ninja, Visual Studio, Xcode...)

Now you are all set to build, run following commands in the root directory of the project:

cmake -Bbuild
cmake --build build --config Release

Now, you have your own node-nim binary file in the build directory.

First, you need to import the node-nim module:

// ES6 Module
import * as NIM from 'node-nim'
// CommonJS
const NIM = require('node-nim')

After importing the module, you can directly use the three types of objects we have instantiated for you, such as IM, chatroom, and qchat. Here is an example:

// IM related functions
NIM.nim.client.init('', '', '', {})
NIM.nim.client.cleanup('')
// Chatroom related functions
NIM.chatroom.init('', '')
NIM.chatroom.cleanup()
// QChat related functions
NIM.qchat.instance.init({ appkey: 'your appkey', app_data_path: 'qchat' })
NIM.qchat.instance.cleanup({})

The objects that can be directly accessed through NIM.nim are:

The object that can be directly accessed through NIM.chatroom corresponds to ChatRoomModule, and you can directly access the member functions under this object.

The objects that can be directly accessed through NIM.qchat are: