nosozu
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2-alpha • Public • Published
    🎋🐼

    Nosozu

    Node.js Client library for interacting with the Sōzu HTTP reverse proxy server.


    This library is still under development, and as such there are no guarantees that it will work under load, if at all,

    Contributions are welcome, see here for an explanation, or jump straight to getting started if you want to explore the codebase.

    Goal

    To provide a resilient API for developers to interact with the Sozu command server using Typescript.

    Take a look at the Elixir version here.

    💾 Install

    📦 NPM

    npm install --save nodesozu

    🏓 Examples

    A minimal example that demonstrates how to send a proxy status command to the Sozu server.

    import { Nosozu } from nosozu
    
    async function main() {
        const socketPath = "/tmp/sozu.sock"
        let client = new Nosozu(socketPath)
        const command = { type: "status" }
        const result = await client.run(command)
        return result
    }
    
    main()

    Find more examples here

    🏗️ Continuous Integration

    GitHub Actions

    One action currently running, CI:

    • Runs code coverage reports upon pushing to the main branch, uploads to Codecov.

    Contributing

    Guidelines on how to contribute can be found here

    There are some living documents here which covers some topics on development.

    License

    Licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

    Standing on the shoulders of giants

    The client code that handles commands is based on work done by Connected Cars, Sozu uses a zero byte separated message to communicate, whereas the original client uses a line-based protocol.

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as per above, without any additional terms or conditions.

    Keywords

    none

    Install

    npm i nosozu

    DownloadsWeekly Downloads

    1

    Version

    2.0.2-alpha

    License

    ISC

    Unpacked Size

    123 kB

    Total Files

    15

    Last publish

    Collaborators

    • davidmaceachern