Skip to content
polyjose

Pre-1.0: polyjose is not published yet, and its APIs may change before 1.0. Read the security policy before you rely on it.

API reference

Each platform’s API reference is generated from the code and hosted where developers on that platform expect to find it. polyjose is pre-1.0 and not published yet, so these references don’t exist yet. Each one becomes available when 0.1.0 is published.

Where each reference lives

Section titled “Where each reference lives”
  • Rust: polyjose on docs.rs, at https://docs.rs/polyjose available when 0.1.0 is published
    The rustdoc reference for the polyjose crate, which docs.rs builds for every release.
  • JavaScript (@polyjose/node and @polyjose/wasm): /api/js/ on this site available when 0.1.0 is published
    One TypeDoc reference for both packages, which share the same API and the same type definitions.
  • Kotlin: polyjose-jvm on javadoc.io, at https://javadoc.io/doc/dev.polyjose/polyjose-jvm available when 0.1.0 is published
    The reference for the Kotlin API that the Android library and the desktop JVM jar share, served by javadoc.io from the published Maven artifacts.
  • Swift: polyjose on Swift Package Index, at https://swiftpackageindex.com/bharathkontham/polyjose/documentation/polyjose available when 0.1.0 is published
    The DocC reference for the Polyjose module, hosted by Swift Package Index.

The same names on every platform

Section titled “The same names on every platform”

Every operation has the same name on every platform, written in that language’s usual casing: snake_case in Rust and camelCase in JavaScript, Kotlin and Swift. Record types are UpperCamelCase everywhere. Once you know an operation on one platform, you can look it up by name in any of the references above. One API on every platform lists the operations side by side.