cleanup of jsdocs of interfaces

ibnlanre · Nov 30, 2023 · 849e274 · 849e274
1 parent 7ae7576
commit 849e274
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 28 deletions.
diff --git a/src/addons/index.ts b/src/addons/index.ts
@@ -1,7 +1,7 @@
+export * from "./makePortal";
 export * from "./useShallowCompare";
 export * from "./useDebouncedShallowEffect";
 export * from "./usePortalImplementation";
 export * from "./useCookieImplementation";
 export * from "./useLocalImplementation";
 export * from "./useSessionImplementation";
-export * from "./makePortal";
diff --git a/src/addons/useCookieImplementation.ts b/src/addons/useCookieImplementation.ts
@@ -25,12 +25,8 @@ export function useCookieImplementation<
   Path extends Paths<Store>,
   State extends GetValueByPath<Store, Path>,
   Data
->({
-  path,
-  initialState,
-  config,
-  portal,
-}: UseCookieImplementation<Store, Path, State, Data>) {
+>(properties: UseCookieImplementation<Store, Path, State, Data>) {
+  const { path, portal, config, initialState } = properties;
   const {
     key = path,
     set = (value: State) => JSON.stringify(value),

diff --git a/src/addons/useLocalImplementation.ts b/src/addons/useLocalImplementation.ts
@@ -23,12 +23,8 @@ export function useLocalImplementation<
   Path extends Paths<Store>,
   State extends GetValueByPath<Store, Path>,
   Data
->({
-  path,
-  portal,
-  config,
-  initialState,
-}: UseLocalImplementation<Store, Path, State, Data>) {
+>(properties: UseLocalImplementation<Store, Path, State, Data>) {
+  const { path, portal, config, initialState } = properties;
   const {
     key = path,
     set = (value: State) => JSON.stringify(value),

diff --git a/src/addons/usePortalImplementation.ts b/src/addons/usePortalImplementation.ts
@@ -51,15 +51,10 @@ export function usePortalImplementation<
   Path extends Paths<Store>,
   State extends GetValueByPath<Store, Path>,
   Data
->({
-  path,
-  initialState,
-  options,
-  portal,
-}: UsePortalImplementation<Store, Path, State, Data>): PortalState<
-  State,
-  Data
-> {
+>(
+  properties: UsePortalImplementation<Store, Path, State, Data>
+): PortalState<State, Data> {
+  const { path, portal, options, initialState } = properties;
   const {
     set,
     select = (value: State) => value as unknown as Data,

diff --git a/src/addons/useSessionImplementation.ts b/src/addons/useSessionImplementation.ts
@@ -23,12 +23,8 @@ export function useSessionImplementation<
   Path extends Paths<Store>,
   State extends GetValueByPath<Store, Path>,
   Data
->({
-  path,
-  portal,
-  config,
-  initialState,
-}: UseSessionImplementation<Store, Path, State, Data>) {
+>(properties: UseSessionImplementation<Store, Path, State, Data>) {
+  const { path, portal, config, initialState } = properties;
   const {
     key = path,
     set = (value: State) => JSON.stringify(value),

diff --git a/src/definition/portal.ts b/src/definition/portal.ts
@@ -3,7 +3,16 @@ import type { SetStateAction, Dispatch } from "react";
 import type { BehaviorSubject, Portal } from "@/subject";
 import { CookieOptions } from "./cookie";
 
+/**
+ * Represents the method to get the portal's initial value.
+ * @template State The type of the state.
+ */
 export type GetState<State> = (state: State) => State;
+
+/**
+ * Represents the method to set the value of the store.
+ * @template State The type of the state.
+ */
 export type SetStore<State> = (value: State) => void;
 
 /**