@minodisk/medkit
v0.8.0
Published
A SDK for post creation and update by emulating operation on Medium's post edit screen with Headless Chromium via puppetter.
Downloads
24
Readme
@minodisk/medkit
A SDK for post creation and update by emulating operation on Medium's post edit screen with Headless Chromium via puppetter.
Installation
npm:
npm install --save @minodisk/medkit
yarn:
yarn add @minodisk/medkit
Usage
import Client from "@minodisk/medkit";
(async () => {
const client = new Client();
const postId = await client.createPost(
"<h3>Title</h3><h4>Subtitle</h4><p>Text</p>",
);
const html = await client.readPost(postId); // -> "<h1>Title</h1><h2>Subtitle</h2><p>Text</p>" or "<h3>Title</h3><h4>Subtitle</h4><p>Text</p>"
await client.updatePost(
postId,
"<h3>Title</h3><h4>Subtitle</h4><p>Modified</p>",
);
await client.destroyPost(postId);
await client.close();
})();
API
new Client(options?: {cookiesPath?: string}): Client
new Client()
returns Client
. cookiesPath
in options
is "cookies.json"
in default.
Client.prototype.createPost(html: string): Promise<string>
createPost
opens Medium's new story screen and pastes the passed html
in the post field. When saving the post is completed, returned Promise
will pass the post ID to the next step and complete.
Client.prototype.readPost(postId: string): Promise<string>
readPost
opens Medium's edit screen with post ID postId
and gets the HTML in post filed. When getting the post HTML is completed, returned Promise
will pass that HTML to the next step and complete.
Client.prototype.updatePost(postId: string, html: string): Promise<void>
updatePost
opens Medium's edit story screen with post ID postId
and pastes the passed html
in the post field. When saving the post is completed, returned Promise
will complete.
Client.prototype.destroyPost(postId: string): Promise<void>
destroyPost
opens Medium's edit story screen with post IDpostId
and clicks delete button. When deleting the post is completed, returned Promise
will complete.
Client.prototype.close(): Promise<void>
close
closes Chromium. When closing Chromium is completed, returned Promise
will complete.