Skip to content

Commit

Permalink
feat(stash): release package to npm (#3184)
Browse files Browse the repository at this point in the history
Co-authored-by: Kevin Ingersoll <[email protected]>
  • Loading branch information
alvrs and holic authored Sep 19, 2024
1 parent 6c87bd8 commit 20fac30
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
11 changes: 11 additions & 0 deletions .changeset/chatty-pigs-shake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"@latticexyz/stash": patch
---

Added `@latticexyz/stash` package, a TypeScript client state library optimized for the MUD Store data model.
It uses the MUD store config to define local tables, which support writing, reading and subscribing to table updates.
It comes with a query engine optimized for "ECS-style" queries (similar to `@latticexyz/recs`) but with native support for composite keys.

You can find usage examples in the [`@latticexyz/stash` README.md](https://github.com/latticexyz/mud/blob/main/packages/stash/README.md).

This package is experimental and will have breaking changes while we refine its APIs and implementation. All of its exports are temporarily under `@latticexyz/stash/internal` until we consider it stable.
3 changes: 3 additions & 0 deletions packages/stash/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Stash

> [!WARNING]
> This package is experimental and will have breaking changes while we refine its APIs and implementation. All of its exports are temporarily under `@latticexyz/stash/internal` until we consider it stable.
Stash is a client state library optimized for the MUD data model.
It uses the MUD store config to define local tables, which support writing, reading and subscribing to table updates.
It comes with a query engine optimized for ["ECS-style"](https://mud.dev/ecs) queries (similar to `@latticexyz/recs`) but with native support for composite keys.
Expand Down
1 change: 0 additions & 1 deletion packages/stash/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "@latticexyz/stash",
"version": "2.2.5",
"private": true,
"description": "High performance client store and query engine for MUD",
"repository": {
"type": "git",
Expand Down

0 comments on commit 20fac30

Please sign in to comment.