t-comm
Version:
专业、稳定、纯粹的工具库
48 lines (47 loc) • 1.65 kB
TypeScript
/**
* 创建 iWiki 文档
* 支持创建 Markdown、新文档、文件夹等类型，需要提供 PaaS 认证信息
* @param {object} config 配置信息
* @param {string} config.prefix API 前缀地址
* @param {string} [config.spacekey] 空间 key（与 spaceId 二选一）
* @param {string} [config.spaceId] 空间 ID（与 spacekey 二选一）
* @param {string} [config.contenttype='MD'] 内容类型，DOC：新文档，MD：Markdown，FOLDER：文件夹
* @param {string} [config.title] 文档标题
* @param {string} [config.body] 文档内容
* @param {string|number} [config.parentid] 父目录 ID
* @param {object} [config.otherData] 其他额外参数
* @param {string} config.paasId PaaS 认证 ID
* @param {string} config.paasToken PaaS 认证 Token
* @returns {Promise<{code: string, msg: string, data: {id: string, docid: string}, request_id: string}>} 创建结果
* @example
* ```ts
* const result = await createIwikiDoc({
* prefix: 'https://iwiki.woa.com/api',
* spacekey: 'my-space',
* title: '新文档',
* body: '# Hello\n内容',
* paasId: 'xxx',
* paasToken: 'xxx',
* });
* ```
*/
export declare function createIwikiDoc({ prefix, spacekey, spaceId, contenttype, title, body, parentid, otherData, paasId, paasToken, }: {
prefix: string;
spacekey?: string;
spaceId?: string;
contenttype?: string;
title?: string;
body?: string;
parentid?: string | number;
otherData?: any;
paasId: string;
paasToken: string;
}): Promise<{
code: string;
msg: string;
data: {
id: string;
docid: string;
};
request_id: string;
}>;