chat-space

Built-in Instance Methods

warning

Experimental Function

Data Buffer

apps/**/*/res.ts

import { BufferData } from 'chat-space'
const BufferDB = new BufferData()

• Convert string address to QR code

apps/**/*/res.ts

const img: Buffer | false = await BufferDB.qrcode('www.baidu.com')

• Read the image at the specified path

apps/**/*/res.ts

const img: Buffer | false = await BufferDB.getPath('xxx.png')

• Read the image at the specified URL

apps/**/*/res.ts

const img: Buffer | false = await BufferDB.getUrl('https://xxxx.com/xxx.png')

• Write data and store it as a file

apps/**/*/res.ts

BufferDB.set('/public/buffer.ini')

• Read file data

apps/**/*/res.ts

const img: Buffer | false = await BufferDB.get('/public/buffer.ini')

Client

Client object for directly calling APIs

Ensures that the development framework does not lose API compatibility

While retaining platform-specific features

apps/**/*/res.ts

import { FilesServer } from 'chat-space'
const ClientFile = new FilesServer()

• Fixed file exposure

apps/**/*/res.ts

const url = await ClientFile.getLocalFileUrl('/plugins/point/public/img/ionc.png')

// url   http://[::]:port/api/xxx?address=/plugins/point/public/img/ionc.png

• Dynamic file exposure

apps/**/*/res.ts

const img: Buffer = '<buffer-img xxx >'
const url = await ClientFile.getFileUrl(img)

// url   http://[::]:port/api/xxx/1234567890.png

IP Address

If the device has a public IP address, it can be obtained as follows:

apps/**/*/res.ts

import { IP } from 'chat-space'
const ip:string : false = await IP.get()

Special interface

warning

Experimental function

(Card|Reaction) differs from other interfaces in that it generally only requires common subfields.

The data format varies for each platform.

一、qq-group

• embed

apps/**/*/res.ts

import { QQGroupBotAPI } from 'chat-space'
const Client = new QQGroupBotAPI()
const cards = [
  {
    embed: {
      title: 'Newcomer Task',
      prompt: 'Newcomer Task',
      thumbnail: {
        url: 'http://tva1.sinaimg.cn/bmiddle/6af89bc8gw1f8ub7pm00oj202k022t8i.jpg'
      },
      fields: [
        {
          name: 'Go go go'
        },
        {
          name: '😁Keep it up'
        }
      ]
    }
  }
]

• emoji

apps/**/*/res.ts

import { QQGroupBotAPI } from 'chat-space'
const Client = new QQGroupBotAPI()

二、qq-guild-bot

• Markdown Template Function

warning

Markdown universal message templates are no longer allowed for application.