fix: hide symbol

.changeset/three-kangaroos-act.md

@@ -0,0 +1,7 @@
+---
+'stable-store': patch
+---
+
+Add JSDocs comments for `onGet` and `onSet`.
+
+Hide the internal `brandedSymbol`.

packages/stable-store/ts/store.on_get.spec.ts

@@ -0,0 +1,9 @@
+import { createStore } from './store.js'
+import { expect, it } from '@jest/globals'
+
+it('listen to get calls', () => {
+	expect.assertions(1)
+	const store = createStore('with-get-listener', { a: 1 })
+	store.onGet(v => expect(v).toEqual({ a: 1 }))
+	store.get()
+})

packages/stable-store/ts/store.ts

@@ -1,8 +1,7 @@
 import { idAssertions, storeMap } from './store.ctx.js'
-import { Store } from './store.types.js'
+import { type Store } from './store.types.js'
 
-
-export const brandedSymbol = Symbol('internal branded symbol')
+const brandedSymbol = Symbol('internal branded symbol')
 
 /**
  * Init value is required.

packages/stable-store/ts/store.types.ts

@@ -6,10 +6,22 @@ export type Store<V> = {
 	 * Get the current value.
 	 */
 	get(): V
-	onGet(fn: (value: V) => void): () => void
+	/**
+	 * Adds a listener function to be called whenever the value is retrieved.
+	 *
+	 * @param {function} listener - A callback function to be called whenever the value is retrieved.
+	 * It should take in one parameter, the retrieved value.
+	 * @return {function} A function that can be called to remove the listener from the list of listeners.
+	 */
+	onGet(listener: (value: V) => void): () => void
 	/**
 	 * Set the value.
 	 */
 	set(value: V): void
-	onSet(fn: (value: V) => void): () => void
+	/**
+	 * Registers a listener to be called when the value is set.
+	 *
+	 * @returns {() => void} An unregister l to remove the listener.
+	 */
+	onSet(listener: (value: V) => void): () => void
 }