Cloudstudio-lite NPM

Cloud-Studio-Lite SDK文档

API

ISDKOptions

参数	说明	类型	是否必填
rootNode	宿主根节点	HTMLElement	true
funcName	函数名	String	false
applyStatistics	申请数据统计	IStatisticsParams	false
helpDocLink	帮助文档链接	String	false

如：

const CSLite = new CloudStudioLiteSDK({
    rootNode: document.querySelector('#root'),
    funcName: 'workspace',
    helpDocLink: 'https://studio.dev.tencent.com/',
    applyStatistics: {
        appId: 'appId-1',
        appKey: 'appKey-1',
        channel: 'channel-1',
        uid: 'uid-1'
    } as IStatisticsParams
});

IStatisticsParams

参数	说明	类型	是否必填
appId	appId	String	true
appKey	appKey	String	true
channel	channel	String	true
uid	uid	String	true

FileTreeModel

参数	说明	类型	是否必填
isFile	是否是文件类型	Boolean	true
path	文件路径(唯一)	String	true
fileName	文件名称	String	true
parentPath	父级文件路径(唯一)	String	true

方法

参数	说明	参数类型	返回值类型
getFileList	获取所有文件列表(未保存文件返回原始内容)	-	IFileValue[]
onOpenFileListen	监听要读取的某文件文本内容的方法	(data: { path: string }) => Promise<{ content: string }>	void
onSaveFileListen	监听要保存的某文件文本内容的方法	(data: { path: string, content: string }) => Promise<boolean>	void
onAddFileListen	监听要新增的文件的方法	(data: { path: string, content: string }) => Promise<boolean>	void
onAddFolderListen	监听要新增的文件夹的方法	(data: { path: string }) => Promise<boolean>	void
onDelFileListen	监听要删除的文件的方法	(data: { path: string }) => Promise<boolean>	void
onDelFolderListen	监听要删除的文件夹的方法	(data: { path: string }) => Promise<boolean>	void
onRenameFileOrFolderListen	监听要重命名的文件或文件夹的方法	(data: { newPath: string, oldPath: string }) => Promise<boolean>	void
onExpandFolderListen	监听要展开的某文件夹的方法	(data: { path: string }) => Promise<FileTreeModel[]>	void

如：

CSLite.onOpenFileListen((data: { path: string }) => {
    const { path } = data;
    return new Promise((res, rej) => {
        // ...TUDO
        res( {content} )
    })
})

CSLite.getFileList() // 返回 IFileValue 类型数组

接口

IFileValue

参数	说明	类型	默认值
fileName	文件名称	String	''
isFile	是否是文件类型	Boolean	false
level	层级	Number	0
content	文件内容	String	''
path	文件路径	String	''
parentPath	父级文件路径	String	''