可对CQCode进行解析、序列化、寻找等操作的一个工具集合。
传入一个字符串,若为合法的CQCode字符串,将会被解析为一个CQCode对象;若为不合法的CQCode字符串,则会抛出异常。
import { parse } from 'cqcode';
parse('[CQ:at,qq=100000]');
{
type: 'at',
data: {
qq: '100000'
}
}
传入一个CQCode对象,将会被序列化为一个CQCode字符串。
import { serialize } from 'cqcode';
serialize({ type: 'at', data: { qq: '100000' } });
'[CQ:at,qq=100000]'
传入一个字符串,将会在其中寻找可能的CQCode对象,将其转化为一个数组返回。
interface FindProps {
type: string | string[]; // 筛选CQCode的类型,不在其中的将会被排除。默认:undefined
ignoreError: boolean; // 是否忽略错误,为false时解析失败将会抛出异常。默认:false
}
import { find } from 'cqcode';
find('This is a [CQ:at,qq=100000] long message.', { type: 'at' });
[
{
type: 'at',
data: {
qq: '100000'
}
}
]
传入一个字符串,将按顺序解析CQCode字符串,解析失败或不为CQCode对象的部分返回type="plain"的CQCode对象。
interface SplitProps {
type: string | string[]; // 筛选CQCode的类型,不在其中的将会被排除。默认:undefined
}
import { split } from 'cqcode';
split('This is a [CQ:at,qq=100000] long message.', { type: ['at', 'plain'] });
[
{
type: 'plain',
data: {
text: 'This is a '
}
}, {
type: 'at',
data: {
qq: '100000'
}
}, {
type: 'plain',
data: {
text: ' long message.'
}
}
]