@pezkuwi/api-derive 16.5.17 → 16.5.19

package/build/membership/index.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @name members
+ * @description Retrieves the list of members in the "membership" collective.
+ * @example
+ * ```javascript
+ * const members = await api.derive.membership.members();
+ * console.log(`Members: ${JSON.stringify(members)});
+ * ```
+ */
+export declare const members: import("../collective/types.js").MembersFnRet;
+/**
+ * @name hasProposals
+ * @description Checks if there are any active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const exists = await api.derive.membership.hasProposals();
+ * console.log(exists);
+ * ```
+ */
+export declare const hasProposals: import("../collective/types.js").HasProposalsFnRet;
+/**
+ * @name proposal
+ * @description Retrieves details of a specific proposal in the "membership" collective by its hash.
+ * @example
+ * ```javascript
+ * const proposalDetails = await api.derive.membership.proposal(PROPOSAL_HASH);
+ * console.log(proposalDetails);
+ * ```
+ */
+export declare const proposal: import("../collective/types.js").ProposalFnRet;
+/**
+ * @name proposalCount
+ * @description Retrieves the total number of proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const count = await api.derive.membership.proposalCount();
+ * console.log(`Amount of proposals: ${count}`);
+ * ```
+ */
+export declare const proposalCount: import("../collective/types.js").ProposalCountFnRet;
+/**
+ * @name proposalHashes
+ * @description Retrieves an array of hashes for all active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const hashes = await api.derive.membership.proposalHashes();
+ * console.log(`Proposals ${JSON.stringify(hashes)}`);
+ * ```
+ */
+export declare const proposalHashes: import("../collective/types.js").ProposalHashesFnRet;
+/**
+ * @name proposals
+ * @description Retrieves a list of all active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const proposals = await api.derive.membership.proposals();
+ * console.log(proposals);
+ * ```
+ */
+export declare const proposals: import("../collective/types.js").ProposalsFnRet;
+/**
+ * @name prime
+ * @description Retrieves the prime member of the "membership" collective, if one exists.
+ * @example
+ * ```javascript
+ * const primeMember = await api.derive.membership.prime();
+ * console.log(primeMember);
+ * ```
+ */
+export declare const prime: import("../collective/types.js").PrimeFnRet;

package/build/membership/index.js

@@ -0,0 +1,71 @@
+import { hasProposals as collectiveHasProposals, members as collectiveMembers, prime as collectivePrime, proposal as collectiveProposal, proposalCount as collectiveProposalCount, proposalHashes as collectiveProposalHashes, proposals as collectiveProposals } from '../collective/index.js';
+/**
+ * @name members
+ * @description Retrieves the list of members in the "membership" collective.
+ * @example
+ * ```javascript
+ * const members = await api.derive.membership.members();
+ * console.log(`Members: ${JSON.stringify(members)});
+ * ```
+ */
+export const members = /*#__PURE__*/ collectiveMembers('membership');
+/**
+ * @name hasProposals
+ * @description Checks if there are any active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const exists = await api.derive.membership.hasProposals();
+ * console.log(exists);
+ * ```
+ */
+export const hasProposals = /*#__PURE__*/ collectiveHasProposals('membership');
+/**
+ * @name proposal
+ * @description Retrieves details of a specific proposal in the "membership" collective by its hash.
+ * @example
+ * ```javascript
+ * const proposalDetails = await api.derive.membership.proposal(PROPOSAL_HASH);
+ * console.log(proposalDetails);
+ * ```
+ */
+export const proposal = /*#__PURE__*/ collectiveProposal('membership');
+/**
+ * @name proposalCount
+ * @description Retrieves the total number of proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const count = await api.derive.membership.proposalCount();
+ * console.log(`Amount of proposals: ${count}`);
+ * ```
+ */
+export const proposalCount = /*#__PURE__*/ collectiveProposalCount('membership');
+/**
+ * @name proposalHashes
+ * @description Retrieves an array of hashes for all active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const hashes = await api.derive.membership.proposalHashes();
+ * console.log(`Proposals ${JSON.stringify(hashes)}`);
+ * ```
+ */
+export const proposalHashes = /*#__PURE__*/ collectiveProposalHashes('membership');
+/**
+ * @name proposals
+ * @description Retrieves a list of all active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const proposals = await api.derive.membership.proposals();
+ * console.log(proposals);
+ * ```
+ */
+export const proposals = /*#__PURE__*/ collectiveProposals('membership');
+/**
+ * @name prime
+ * @description Retrieves the prime member of the "membership" collective, if one exists.
+ * @example
+ * ```javascript
+ * const primeMember = await api.derive.membership.prime();
+ * console.log(primeMember);
+ * ```
+ */
+export const prime = /*#__PURE__*/ collectivePrime('membership');