message

约 833 字大约 3 分钟

2025-05-15

注

本文由 AI 辅助生成，可能存在不准确性。

message 模块提供了消息处理的工具函数，用于创建和处理各种消息元素。

消息处理函数

createRawMessage

将消息元素数组转换为原始字符串和纯文本。

import { createRawMessage
 } from 'node-karin'

/**
 * 将消息元素转换为字符串
 * @param data 消息元素数组
 * @returns 包含原始字符串和纯文本的对象
 */
const { raw
, msg
 } = createRawMessage
([
  { type
: 'at', targetId
: '123456' },
  { type
: 'text', text
: '你好' },
])

// raw: "[at:123456]你好"
// msg: "你好"

makeMessage

消息元素归一化，主要处理字符串文本。

import { makeMessage
 } from 'node-karin'

/**
 * 消息元素归一化
 * @param elements 消息，可以是字符串、单个元素或元素数组
 * @returns 标准化后的消息元素数组
 */
// 将字符串转换为文本元素
const elements1
 = makeMessage
('你好')
// 将混合内容规范化
const elements2
 = makeMessage
(['你好', { type
: 'at', targetId
: '123456' }])

makeForward

制作简单转发消息。

import { makeForward
 } from 'node-karin'

/**
 * 制作简单转发消息
 * @param elements 消息内容数组
 * @param fakeId 转发用户的ID
 * @param fakeName 转发用户显示的昵称
 * @returns 转发节点元素数组
 */
const forwardMsg
 = makeForward
([['第一条消息'], [{ type
: 'text', text
: '第二条消息' }]], '123456', '用户昵称')Type 'string' is not assignable to type 'Elements'.

消息段构造函数

message 模块通过segment子模块提供了丰富的消息段构造器：

基础消息段

import { segment } from 'node-karin'

// 文本消息
const textMsg
 = segment.text
('这是一段文本')

// At消息
const atMsg
 = segment.at
('123456', '用户昵称')
const atAll
 = segment.at
('all') // @全体成员

// 表情
const faceMsg
 = segment.face
(123)

// 回复
const replyMsg
 = segment.reply
('message-id-123')

媒体消息段

// 图片消息
const imgMsg
 = segment.image('https://example.com/image.jpg')Cannot find name 'segment'.
const imgMsg2
 = segment.image('/path/to/image.jpg', {Cannot find name 'segment'.
  width
: 100,
  height
: 100,
  name
: '图片名称',
})

// 视频消息
const videoMsg
 = segment.video('https://example.com/video.mp4')Cannot find name 'segment'.

// 语音消息
const recordMsg
 = segment.record('https://example.com/audio.mp3')Cannot find name 'segment'.
const magicRecordMsg
 = segment.record('https://example.com/audio.mp3', true) // 魔法语音Cannot find name 'segment'.

结构化消息段

// JSON消息
const jsonMsg
 = segment.json('{"type":"LightApp","data":{}}')Cannot find name 'segment'.

// XML消息
const xmlMsg
 = segment.xml('<xml></xml>')Cannot find name 'segment'.

// Markdown消息
const mdMsg
 = segment.markdown('# 标题\n内容')Cannot find name 'segment'.

// Markdown模板
const mdTplMsg
 = segment.markdownTpl('template-id', { key
: 'value' })Cannot find name 'segment'.

交互消息段

// 按钮
const btnMsg
 = segment.button({ text
: '点击按钮', data
: 'button-data' })Cannot find name 'segment'.

// 多行按钮
const keyboardMsg
 = segment.keyboard([Cannot find name 'segment'.
  [
    { text
: '按钮1', data
: 'data1' },
    { text
: '按钮2', data
: 'data2' },
  ],
  [{ text
: '按钮3', data
: 'data3' }],
])

// 地理位置
const locationMsg
 = segment.location(39.908823, 116.39747, '天安门', '北京市东城区天安门')Cannot find name 'segment'.

// 分享
const shareMsg
 = segment.share('https://example.com', '标题', '内容描述', 'https://example.com/image.jpg')Cannot find name 'segment'.

// 音乐分享
const musicMsg
 = segment.music('qq', '123456')Cannot find name 'segment'.
const customMusicMsg
 = segment.customMusic(Cannot find name 'segment'.
  'https://example.com', // 跳转链接
  'https://example.com/1.mp3', // 音频链接
  '音乐标题',
  '作者',
  'https://example.com/cover.jpg' // 封面图片
)

游戏消息段

// 骰子
const diceMsg
 = segment.dice(3) // 点数为3的骰子Cannot find name 'segment'.

// 石头剪刀布
const rpsMsg
 = segment.rps(2) // 0-石头 1-剪刀 2-布Cannot find name 'segment'.

// 篮球
const basketballMsg
 = segment.basketball(1) // 0-未知 1-进了 2-没进Cannot find name 'segment'.

转发消息

import { segment } from 'node-karin'

// 自定义转发节点
const nodeMsg
 = segment.node
(
  '123456', // 用户ID
  '用户昵称', // 用户昵称
  [
    // 消息内容
    segment.text
('这是转发的消息内容'),
  ],
  {
    // 可选配置
    time: Math
.floor
(Date
.now
() / 1000),Object literal may only specify known properties, and 'time' does not exist in type 'ForwardOptions'.
  }
)

// 已有转发消息节点
const directNodeMsg
 = segment.nodeDirect
('forward-id-123')