Clipy Mate Core
Access Clipy From Node.js
English | 日本語
Introduction
Clipy is a Clipboard extension app for macOS. This package allow developers access Clipy's folders and snippets using Node.js.
It also provides TypeScript API and all tests are written by TypeScript.
[Attention] This package will access Clipy's Realm Database directly, so you may need to restart Clipy App if snippets updated.
Table of Contents
Requirements
- MacOS 10.10 and over
- Clipy v1.2.0 and over
- Node.js v8.9.0 and < v12 (Why?)
Installation
Use the package manager npm to install.
npm i clipy-mate-core
Usage
Import
const ClipyMate = ;const clipy = ;
;
Read Snippets
// Read all Folders and Snippetsclipy;
Parse XML
// Parse `snippet.xml`const fs = ;clipy;
Create and Update
// Create or Update a folder// it will update a folder has same `identifier` field// or create a new folder if `identifier` is blank or not foundclipy; // Create or Update a snippet inside a folder// it will update a snippet has same `identifier` field// or create a new snippet if `identifier` is blank or not foundconst folder = clipyCPYFolder0;const folderId = folderidentifier;clipy;
Destroy
// Destroy a specific folder (All snippets in this folder will also be destroyed)const folder = clipyCPYFolder0;const folderId = folderidentifier;clipy; // Destroy a specific snippetconst snippet = clipyCPYSnippet0;const snippetId = snippetidentifier;clipy; // [Danger!] Destroy all folders and snippetsclipy;
Close Realm Connection
// After allclipy;
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.