SHARKEY.TS 🦈 🦕

GitHub CI

A Typescript library for Deno to interact with Sharkey, a Mastodon alternative. 🦈 🦕

ABOUT 📚

This library for Deno is there to interact with Sharkey from Typescript. I wrote this to prototype a library in another programming language and get a feel for Sharkey's API routes.

USAGE 🔨

APIs

To get the documentation for this library, please visit this library's documentation pages shere. Please also take care to import Sharkey.ts via an HTTP import or by adding it to your Deno project. The documentation gives inaccurate information on imports (This is not down to me, this is a known issue with Deno.).

You can import any of Sharkey.ts's APIs by adding the following line to your Typescript file:

import { functionName } 'https://deno.land/x/sharkey/mod.ts';

functionName represents any of the function signatures present in the documentation pages.

EXAMPLE

To get a feel for how to use Sharkey.ts, please read the unit tests located in mod_test.ts.

CHANGELOG ✒️

Version 0.1.0

  • Initial release.
  • Upload to GitHub.
  • Upload to deno.land/x.

NOTE 📜

  • Sharkey.ts 🦈 🦕 by Alexander Abraham 🖤 a.k.a. "Angel Dollface" 🎎 🎀
  • Licensed under the DSL v1.