elysia-msgpack

KO | EN

gitlite — search

#react #typescript #llm #rust #deep-learning #linux #docker #nodejs #windows #cli #vue #pytorch #security #open-source

(★ 17)

No description available.

elysia-msgpack Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# elysia-msgpack

The library for [elysia](https://elysiajs.com) which allows you to work with [MessagePack](https://msgpack.org). To pack/unpack it, we use really fast [msgpackr](https://github.com/kriszyp/msgpackr)

## Installation

```bash
bun install elysia-msgpack
```

## Usage

```ts
// @filename: server.ts
import Elysia from "elysia"
import { msgpack } from "elysia-msgpack"

const app = new Elysia()
    .use(msgpack())
    .post("/", ({ body, msgpack }) => {
        // body is unpacked MessagePack if content-type header contains application/x-msgpack

//  also you can work with Packr instance via msgpack decorator

// if accept header contains application/x-msgpack
        // this response will become a MessagePack,
        // and if not, it will remain JSON
        return {
            some: "values",
            and: true,
            keys: 228,
        }
    })
    .listen(3000);

export AppType = typeof app;
```

It works fine with [End-to-End Type Safety](https://elysiajs.com/eden/overview.html) too!

```ts
// @filename: client.ts
import { treaty } from "@elysiajs/eden";
import { pack, unpack } from "msgpackr";
import type { AppType } from "./server";

const { data, error } = await app.index.post({
    some: 228,
});

console.log(data);
```

### Options

[All options of msgpackr constructor](https://github.com/kriszyp/msgpackr?tab=readme-ov-file#options) (but we set useRecords to `false` by default)

| Key           | Type                                                                 | Default                   | Description                                                         |
| ------------- | -------------------------------------------------------------------- | ------------------------- | ------------------------------------------------------------------- |
| contentTypes? | string[]                                                             | ["application/x-msgpack"] | An array of `content-types` that need to be serialized/deserialized |
| force?        | boolean                                                              | false                     | Don't look at the `accept` header to serialize?                     |
| as?           | [LifeCycleType](https://elysiajs.com/essential/scope.html#hook-type) | "scoped"                  | Option to specify `type` of hooks                                   |

```ts
new Elysia()
    .use(msgpack({
        mimeType: "application/some-another-msgpack-type",
        int64AsType: "string",
        // and other msgpackr constructor options
    }))
```

You can use [Apidog](https://apidog.com/) to test the API with msgpack.

elysia-msgpack

elysia-msgpack Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

elysia-msgpack

elysia-msgpack Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README