مقدمه ای بر GROWI TypeScript/JavaScript SDK (بخش 3: دستکاری پیوست ها)

Summarize this content to 400 words in Persian Lang
یک REST API در GROWI، یک ویکی منبع باز داخلی در دسترس است. ما در حال توسعه یک TypeScript/JavaScript SDK هستیم تا استفاده از این API را آسان‌تر کنیم. هنوز در حال انجام است، اما من به تدریج عملکردهای بیشتری را اضافه خواهم کرد.

این مقاله نحوه عملکرد پیوست ها را توضیح می دهد.

یادداشت ها

این یک SDK انجمن است. لطفا از تماس با مسئول خودداری فرمایید.

کد منبع

کد منبع GROWI TypeScript/JavaScript SDK در GitHub موجود است. مجوز MIT است.

goofmint/growi-sdk-alpha

نصب و راه اندازی.

نصب از طریق npm/yarn انجام می شود.

$ npm install @goofmint/growi-js
# or
$ yarn add @goofmint/growi-js

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

استفاده

ابتدا SDK را وارد کنید.

const { GROWI } = require(‘@goofmint/growi-js’);
// or
import { GROWI } from ‘@goofmint/growi-js’;.

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

سپس، مقداردهی اولیه کنید. در این مرحله، توکن API را برای GROWI مشخص کنید.

const growi = new GROWI({ apiToken: ‘your-api-token’ });

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

علاوه بر این، پارامترهای زیر ارائه شده است.

url : نشانی اینترنتی GROWI را مشخص می کند. پیش فرض است http://localhost:3000.

path : مسیر صفحه GROWI را مشخص می کند. پیش فرض به ”. هنگام نصب در یک زیر شاخه مشخص کنید.

دریافت صفحه

پیوست ها به صفحات گره خورده اند، بنابراین ابتدا صفحه را بازیابی کنید. برای بازیابی یک صفحه از ریشه، موارد زیر را انجام دهید. مقدار بازگشتی a است Page شی

const page = await growi.root();

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

بازیابی بر اساس نام صفحه

اگر نام صفحه (مسیر) را می دانید، از آن استفاده کنید page روش

const page = await growi.page({path: ‘/page name’});

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

پیوست ها را بارگذاری کنید

استفاده کنید upload روش برای پیوست ساده ترین راه این است که مسیر فایل را مشخص کنید.

const fileName = ‘logo.png’;.
const attachment = await page.upload(path.resolve(‘path’, ‘to’, fileName));

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

پس از بازیابی، URL تصویر را می توان با آن بازیابی کرد attachment.filePathProxied. می توان آن را به صورت زیر به بدن اضافه کرد.

page.set(‘body’, `${page.body}\n\n`);

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

دریافت لیستی از پیوست ها

می توانید استفاده کنید list روش دریافت لیستی از پیوست ها

const res = await Attachment.list(page);
res.attachments // array of Attachment instances
res.limit // 10
res.page // 1
res.totalDocs // 20

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

بررسی کنید که آیا فایلی قابل آپلود است یا خیر

با تعیین اندازه فایل می توانید بررسی کنید که آیا یک فایل می تواند آپلود شود یا خیر. توجه داشته باشید که مقدار پیش فرض برای GROWI اندازه نامحدود است.

const bol = await Attachment.limit(1024 * 1024 * 10);
bol // true

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

در حال بازیابی پیوست ها

برای بازیابی پیوست، از find روش با شناسه پیوست

const a = await Attachment.find(id);
a // Attachment instance

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

خلاصه

به عنوان یک ویکی داخلی، GROWI احتمالاً نیازهای پیوند داده با سیستم های داخلی دارد. لطفاً از Node.js SDK برای اجرای GROWI از سیستم خود استفاده کنید.

GROWI، یک ابزار ویکی توسعه OSS | به اشتراک گذاری راحت اطلاعات برای همه

$ npm install @goofmint/growi-js
# or
$ yarn add @goofmint/growi-js

const { GROWI } = require('@goofmint/growi-js');
// or
import { GROWI } from '@goofmint/growi-js';.

const growi = new GROWI({ apiToken: 'your-api-token' });

const page = await growi.root();

const page = await growi.page({path: '/page name'});

const fileName = 'logo.png';.
const attachment = await page.upload(path.resolve('path', 'to', fileName));

page.set(‘body’, `${page.body}\n\n![](${attachment.filePathProxied})`);

const res = await Attachment.list(page);
res.attachments // array of Attachment instances
res.limit // 10
res.page // 1
res.totalDocs // 20

const bol = await Attachment.limit(1024 * 1024 * 10);
bol // true

const a = await Attachment.find(id);
a // Attachment instance