Files

56 lines
29 KiB
HTML

<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@nats-io/obj</title><meta name="description" content="Documentation for @nats-io/obj"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@nats-io/obj</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@nats-io/obj</h1></div><div class="tsd-panel tsd-typography"><p><a href="./LICENSE"><img src="https://img.shields.io/badge/Licence-Apache%202.0-blue.svg" alt="License"></a>
<img src="https://github.com/nats-io/nats.js/actions/workflows/test.yml/badge.svg" alt="obj">
<a href="https://nats-io.github.io/nats.js/obj/index.html"><img src="https://img.shields.io/badge/JSDoc-reference-blue" alt="JSDoc"></a></p>
<p><a href="https://jsr.io/@nats-io/obj"><img src="https://jsr.io/badges/@nats-io/obj" alt="JSR"></a>
<a href="https://jsr.io/@nats-io/obj"><img src="https://jsr.io/badges/@nats-io/obj/score" alt="JSR"></a></p>
<p><a href="https://www.npmjs.com/package/@nats-io/obj"><img src="https://img.shields.io/npm/v/%40nats-io%2Fobj" alt="NPM Version"></a>
<img src="https://img.shields.io/npm/dt/%40nats-io%2Fobj" alt="NPM Downloads">
<img src="https://img.shields.io/npm/dm/%40nats-io%2Fobj" alt="NPM Downloads"></p>
<h1 id="obj" class="tsd-anchor-link">Obj<a href="#obj" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>The obj module implements the NATS ObjectStore functionality using JetStream for
JavaScript clients. JetStream clients can use streams to store and access data.
Obj is materialized view that presents a different <em>API</em> to interact with the
data stored in a stream using the API for an ObjectStore which should be
familiar to many application developers.</p>
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>For a quick overview of the libraries and how to install them, see
<a href="media/runtimes.md">runtimes.md</a>.</p>
<p>Note that this library is distributed in two different registries:</p>
<ul>
<li>npm a node-specific library supporting CJS (<code>require</code>) and ESM (<code>import</code>)</li>
<li>jsr a node and other ESM (<code>import</code>) compatible runtimes (deno, browser, node)</li>
</ul>
<p>If your application doesn't use <code>require</code>, you can simply depend on the JSR
version.</p>
<h3 id="npm" class="tsd-anchor-link">NPM<a href="#npm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The NPM registry hosts a node-only compatible version of the library
<a href="https://www.npmjs.com/package/@nats-io/obj">@nats-io/obj</a> supporting both CJS
and ESM:</p>
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@nats-io/obj</span>
</code><button type="button">Copy</button></pre>
<h3 id="jsr" class="tsd-anchor-link">JSR<a href="#jsr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The JSR registry hosts the EMS-only <a href="https://jsr.io/@nats-io/obj">@nats-io/obj</a>
version of the library.</p>
<pre><code class="bash"><span class="hl-0">deno</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">jsr:@nats-io/obj</span>
</code><button type="button">Copy</button></pre>
<pre><code class="bash"><span class="hl-0">npx</span><span class="hl-1"> </span><span class="hl-2">jsr</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@nats-io/obj</span>
</code><button type="button">Copy</button></pre>
<pre><code class="bash"><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">dlx</span><span class="hl-1"> </span><span class="hl-2">jsr</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@nats-io/obj</span>
</code><button type="button">Copy</button></pre>
<pre><code class="bash"><span class="hl-0">bunx</span><span class="hl-1"> </span><span class="hl-2">jsr</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@nats-io/obj</span>
</code><button type="button">Copy</button></pre>
<h2 id="referencing-the-library" class="tsd-anchor-link">Referencing the library<a href="#referencing-the-library" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Once you import the library, you can reference in your code as:</p>
<pre><code class="javascript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Objm</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nats-io/obj&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// or in node (only when using CJS)</span><br/><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">Objm</span><span class="hl-1"> } = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-2">&quot;@nats-io/obj&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// using a nats connection:</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">objm</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Objm</span><span class="hl-1">(</span><span class="hl-4">nc</span><span class="hl-1">);</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">objm</span><span class="hl-1">.</span><span class="hl-0">list</span><span class="hl-1">();</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">objm</span><span class="hl-1">.</span><span class="hl-0">create</span><span class="hl-1">(</span><span class="hl-2">&quot;myobj&quot;</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<p>If you want to customize some of the JetStream options when working with KV, you
can:</p>
<pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">jetStream</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nats-io/jetstream&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Objm</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nats-io/obj&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">js</span><span class="hl-1"> = </span><span class="hl-0">jetstream</span><span class="hl-1">(</span><span class="hl-4">nc</span><span class="hl-1">, { </span><span class="hl-4">timeout:</span><span class="hl-1"> </span><span class="hl-8">10_000</span><span class="hl-1"> });</span><br/><span class="hl-5">// KV will inherit all the options from the JetStream client</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">objm</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Objm</span><span class="hl-1">(</span><span class="hl-4">js</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<pre><code class="typescript"><span class="hl-5">// create the named ObjectStore or bind to it if it exists:</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">objm</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Objm</span><span class="hl-1">(</span><span class="hl-4">nc</span><span class="hl-1">);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">os</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">objm</span><span class="hl-1">.</span><span class="hl-0">create</span><span class="hl-1">(</span><span class="hl-2">&quot;testing&quot;</span><span class="hl-1">, { </span><span class="hl-4">storage:</span><span class="hl-1"> </span><span class="hl-4">StorageType</span><span class="hl-1">.</span><span class="hl-4">File</span><span class="hl-1"> });</span><br/><br/><span class="hl-5">// ReadableStreams allows JavaScript to work with large data without</span><br/><span class="hl-5">// necessarily keeping it all in memory.</span><br/><span class="hl-5">//</span><br/><span class="hl-5">// ObjectStore reads and writes to JetStream via ReadableStreams</span><br/><span class="hl-5">// https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream</span><br/><span class="hl-5">// You can easily create ReadableStreams from static data or iterators</span><br/><br/><span class="hl-5">// here&#39;s an example of creating a readable stream from static data</span><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">readableStreamFrom</span><span class="hl-1">(</span><span class="hl-4">data</span><span class="hl-1">: </span><span class="hl-9">Uint8Array</span><span class="hl-1">): </span><span class="hl-9">ReadableStream</span><span class="hl-1">&lt;</span><span class="hl-9">Uint8Array</span><span class="hl-1">&gt; {</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">ReadableStream</span><span class="hl-1">&lt;</span><span class="hl-9">Uint8Array</span><span class="hl-1">&gt;({</span><br/><span class="hl-1"> </span><span class="hl-0">pull</span><span class="hl-1">(</span><span class="hl-4">controller</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// the readable stream adds data</span><br/><span class="hl-1"> </span><span class="hl-4">controller</span><span class="hl-1">.</span><span class="hl-0">enqueue</span><span class="hl-1">(</span><span class="hl-4">data</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">controller</span><span class="hl-1">.</span><span class="hl-0">close</span><span class="hl-1">();</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">// reading from a ReadableStream is similar to working with an async iterator:</span><br/><span class="hl-6">async</span><span class="hl-1"> </span><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">fromReadableStream</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">rs</span><span class="hl-1">: </span><span class="hl-9">ReadableStream</span><span class="hl-1">&lt;</span><span class="hl-9">Uint8Array</span><span class="hl-1">&gt;,</span><br/><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">let</span><span class="hl-1"> </span><span class="hl-4">i</span><span class="hl-1"> = </span><span class="hl-8">1</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">reader</span><span class="hl-1"> = </span><span class="hl-4">rs</span><span class="hl-1">.</span><span class="hl-0">getReader</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">while</span><span class="hl-1"> (</span><span class="hl-6">true</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">done</span><span class="hl-1">, </span><span class="hl-7">value</span><span class="hl-1"> } = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">reader</span><span class="hl-1">.</span><span class="hl-0">read</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">done</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">break</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">value</span><span class="hl-1"> &amp;&amp; </span><span class="hl-4">value</span><span class="hl-1">.</span><span class="hl-4">length</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// do something with the accumulated data</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`chunk </span><span class="hl-6">${</span><span class="hl-4">i</span><span class="hl-1">++</span><span class="hl-6">}</span><span class="hl-2">: </span><span class="hl-6">${</span><span class="hl-4">sc</span><span class="hl-10">.</span><span class="hl-0">decode</span><span class="hl-10">(</span><span class="hl-4">value</span><span class="hl-10">)</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">let</span><span class="hl-1"> </span><span class="hl-4">e</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&quot;hello&quot;</span><span class="hl-1">);</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`hello entry exists? </span><span class="hl-6">${</span><span class="hl-4">e</span><span class="hl-10"> </span><span class="hl-1">!==</span><span class="hl-10"> </span><span class="hl-6">null</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// watch notifies when a change in the object store happens</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">watch</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">watch</span><span class="hl-1">();</span><br/><span class="hl-1">(</span><span class="hl-6">async</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">for</span><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> (</span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">i</span><span class="hl-1"> </span><span class="hl-6">of</span><span class="hl-1"> </span><span class="hl-4">watch</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// when asking for history you get a null</span><br/><span class="hl-1"> </span><span class="hl-5">// that tells you when all the existing values</span><br/><span class="hl-1"> </span><span class="hl-5">// are provided</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">i</span><span class="hl-1"> === </span><span class="hl-6">null</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">continue</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`watch: </span><span class="hl-6">${</span><span class="hl-4">i</span><span class="hl-1">!</span><span class="hl-10">.</span><span class="hl-4">name</span><span class="hl-6">}</span><span class="hl-2"> deleted?: </span><span class="hl-6">${</span><span class="hl-4">i</span><span class="hl-1">!</span><span class="hl-10">.</span><span class="hl-4">deleted</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-5">// putting an object returns an info describing the object</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">info</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">put</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">&quot;hello&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">description:</span><span class="hl-1"> </span><span class="hl-2">&quot;first entry&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">options:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">max_chunk_size:</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">}, </span><span class="hl-0">readableStreamFrom</span><span class="hl-1">(</span><span class="hl-4">sc</span><span class="hl-1">.</span><span class="hl-0">encode</span><span class="hl-1">(</span><span class="hl-2">&quot;hello world&quot;</span><span class="hl-1">)));</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">`object size: </span><span class="hl-6">${</span><span class="hl-4">info</span><span class="hl-10">.</span><span class="hl-4">size</span><span class="hl-6">}</span><span class="hl-2"> number of chunks: </span><span class="hl-6">${</span><span class="hl-4">info</span><span class="hl-10">.</span><span class="hl-4">size</span><span class="hl-6">}</span><span class="hl-2"> deleted: </span><span class="hl-6">${</span><span class="hl-4">info</span><span class="hl-10">.</span><span class="hl-4">deleted</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">,</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-5">// reading it back:</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">r</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&quot;hello&quot;</span><span class="hl-1">);</span><br/><span class="hl-5">// it is possible while we read the ReadableStream that something goes wrong</span><br/><span class="hl-5">// the error property on the result will resolve to null if there&#39;s no error</span><br/><span class="hl-5">// otherwise to the error from the ReadableStream</span><br/><span class="hl-4">r</span><span class="hl-1">?.</span><span class="hl-4">error</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">((</span><span class="hl-4">err</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">(</span><span class="hl-2">&quot;reading the readable stream failed:&quot;</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// use our sample stream reader to process output to the console</span><br/><span class="hl-5">// chunk 1: h</span><br/><span class="hl-5">// chunk 2: e</span><br/><span class="hl-5">// ...</span><br/><span class="hl-5">// chunk 11: d</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">fromReadableStream</span><span class="hl-1">(</span><span class="hl-4">r</span><span class="hl-1">!.</span><span class="hl-4">data</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// list all the entries in the object store</span><br/><span class="hl-5">// returns the info for each entry</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">list</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">list</span><span class="hl-1">();</span><br/><span class="hl-4">list</span><span class="hl-1">.</span><span class="hl-0">forEach</span><span class="hl-1">((</span><span class="hl-4">i</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`list: </span><span class="hl-6">${</span><span class="hl-4">i</span><span class="hl-10">.</span><span class="hl-4">name</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// you can also get info on the object store as a whole:</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">status</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">status</span><span class="hl-1">();</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`bucket: &#39;</span><span class="hl-6">${</span><span class="hl-4">status</span><span class="hl-10">.</span><span class="hl-4">bucket</span><span class="hl-6">}</span><span class="hl-2">&#39; size in bytes: </span><span class="hl-6">${</span><span class="hl-4">status</span><span class="hl-10">.</span><span class="hl-4">size</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// you can prevent additional modifications by sealing it</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">final</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">seal</span><span class="hl-1">();</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`bucket: &#39;</span><span class="hl-6">${</span><span class="hl-4">final</span><span class="hl-10">.</span><span class="hl-4">bucket</span><span class="hl-6">}</span><span class="hl-2">&#39; sealed: </span><span class="hl-6">${</span><span class="hl-4">final</span><span class="hl-10">.</span><span class="hl-4">sealed</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// only other thing that you can do is destroy it</span><br/><span class="hl-5">// this gets rid of the objectstore</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">destroyed</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">os</span><span class="hl-1">.</span><span class="hl-0">destroy</span><span class="hl-1">();</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`destroyed: </span><span class="hl-6">${</span><span class="hl-4">destroyed</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#obj"><span>Obj</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><ul><li><a href="#npm"><span>NPM</span></a></li><li><a href="#jsr"><span>JSR</span></a></li></ul></li><li><a href="#referencing-the-library"><span>Referencing the library</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@nats-io/obj</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>