0.0.1 • Published 2 years ago

@conworkshop/sdk-js v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

ConWorkshop SDK

This is very alpha! An SDK that works with the under development APIs for the Conlang Workshop site (conworkshop.com).

Installation:

npm install @conworkshop/sdk-js
yarn add @conworkshop/sdk-js

TypeScript native. Transpiled to JavaScript.

Here is a super quick example of what it can do so far:

import { ConWorkshopSDK } from '@conworkshop/sdk-js';

const cwsSdk = new ConWorkshopSDK({
  apiAccessId: '53c4fe78-8cd7-453b-aaca-9000c5654f47',
  apiAccessSecret:
    'bc1.86296d67fcc7b30492dc5cfe583cf596e709ebd9b8fe8129296497fc4c3512a8',
  baseUrl: 'http://localhost:8080/api2',
});
const phonology = await cwsSdk.phonology('ZES');

const ipa = phonology.estimatePhonetics('ækerēra');
console.log(ipa); // "ækɛri:rɑ"

const altered = phonology.evaluatePhoMo('V/e', 'atir');
console.log(altered); // "eter"

NOTE: The PhoMo 3.0 implementation is currently incomplete