Commit cd9eccda authored Jul 01, 2026 by imtase

docs(nexus): clarify legacy compatibility policy refs #5

parent 3a499da9

dist/dblurt.d.ts

+2 −1

Original line number	Diff line number	Diff line
		@@ -4390,9 +4390,10 @@ declare module 'dblurt/helpers/nexus' {
		*/
		listTopCommunities(limit?: number): Promise<NexusCommunitySummary[]>;
		/**
		* Returns a list communities by new subscriber count.
		* Returns a list of communities by new subscriber count.
		* The content of a community array is [community name, community title].
		* @param limit Number of listed communities, default: 25 [optional].
		* @deprecated Use the correctly spelled `listPopCommunities` alias. This historical misspelling remains supported for backward compatibility.
		*/
		listPopComunities(limit?: number): Promise<NexusCommunitySummary[]>;
		/** Correctly spelled alias for `listPopComunities`. */

dist/dblurt.js.map

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

docs/classes/index.Nexus.html

+10 −9

File changed.

Preview size limit exceeded, changes collapsed.

docs/documents/nexus.html

+2 −2

Original line number	Diff line number	Diff line
		@@ -21,9 +21,9 @@
		<pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">profile</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-5">nexus</span><span class="hl-1">.</span><span class="hl-0">getProfile</span><span class="hl-1">(</span><span class="hl-2">'beblurt'</span><span class="hl-1">, </span><span class="hl-3">null</span><span class="hl-1">);</span><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">profile</span><span class="hl-1">.</span><span class="hl-5">name</span><span class="hl-1">);</span>
		</code><button type="button">Copy</button></pre>

		<a id="md:typed-option-objects" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Typed option objects<a href="#md:typed-option-objects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Several pagination-heavy helpers now accept typed option objects in addition to the original positional signatures. Prefer option objects for new code because they make nullable cursor, observer and filter semantics explicit while preserving existing positional compatibility.</p>
		<a id="md:typed-option-objects" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Typed option objects<a href="#md:typed-option-objects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Several pagination-heavy helpers accept typed option objects in addition to the original positional signatures. <strong>Maintainer policy:</strong> positional Nexus signatures are legacy-supported but not deprecated for now; they are stable public API and remain useful for concise simple reads. Prefer option objects for new pagination/filter-heavy code because they make nullable cursor, observer and filter semantics explicit while preserving existing positional compatibility.</p>
		<p>Examples include <code>accountNotifications</code>, <code>getAccountPosts</code>, <code>getRankedPosts</code>, <code>listCommunities</code>, <code>postNotifications</code>, <code>unreadNotifications</code>, <code>referralAccounts</code> and <code>referralAccountsCount</code>.</p>
		<p><code>listPopComunities</code> remains available with its historical spelling. New code may use the corrected alias <code>listPopCommunities</code>; both route to the same <code>bridge.list_pop_communities</code> method.</p>
		<p><code>listPopComunities</code> remains available with its historical spelling but is deprecated. New code should use the corrected alias <code>listPopCommunities</code>; both route to the same <code>bridge.list_pop_communities</code> method.</p>
		<a id="md:common-helpers" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Common helpers<a href="#md:common-helpers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><table>
		<thead>
		<tr>

guide/nexus.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -42,11 +42,11 @@ console.log(profile.name);

		## Typed option objects

		Several pagination-heavy helpers now accept typed option objects in addition to the original positional signatures. Prefer option objects for new code because they make nullable cursor, observer and filter semantics explicit while preserving existing positional compatibility.
		Several pagination-heavy helpers accept typed option objects in addition to the original positional signatures. Maintainer policy: positional Nexus signatures are legacy-supported but not deprecated for now; they are stable public API and remain useful for concise simple reads. Prefer option objects for new pagination/filter-heavy code because they make nullable cursor, observer and filter semantics explicit while preserving existing positional compatibility.

		Examples include `accountNotifications`, `getAccountPosts`, `getRankedPosts`, `listCommunities`, `postNotifications`, `unreadNotifications`, `referralAccounts` and `referralAccountsCount`.

		`listPopComunities` remains available with its historical spelling. New code may use the corrected alias `listPopCommunities`; both route to the same `bridge.list_pop_communities` method.
		`listPopComunities` remains available with its historical spelling but is deprecated. New code should use the corrected alias `listPopCommunities`; both route to the same `bridge.list_pop_communities` method.

		## Common helpers