floppy-disk 2.4.0-beta.3 → 2.4.0

package/esm/preact/create-mutation.d.ts

@@ -33,4 +33,7 @@ export type CreateMutationOptions<TVar, TResponse = any, TError = unknown> = Ini
     onError?: (error: TError, variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
     onSettled?: (variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 export declare const createMutation: <TVar, TResponse = any, TError = unknown>(mutationFn: (variables: TVar, state: MutationState<TVar, TResponse, TError>) => Promise<TResponse>, options?: CreateMutationOptions<TVar, TResponse, TError>) => UseMutation<TVar, TResponse, TError>;

package/esm/preact/create-mutation.js

@@ -1,5 +1,8 @@
 import { noop } from '../utils';
 import { createStore } from './create-store';
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 export const createMutation = (mutationFn, options = {}) => {
     const { onMutate = noop, onSuccess = noop, onError = noop, onSettled = noop, ...createStoreOptions } = options;
     const useMutation = createStore(({ set, get }) => ({

package/esm/preact/create-query.d.ts

@@ -198,7 +198,9 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      *
      * Disabled by default.
      *
-     * If the query is on error state, the polling interval will be disabled, and it will use `retry` instead.
+     * If last data fetching is failed, the polling interval will be disabled, and it will use `retry` mechanism instead.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/polling
      */
     refetchInterval?: number | false | ((state: QueryState<TKey, TResponse, TData, TError>) => number | false);
 };
@@ -258,4 +260,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
         error?: FunctionComponent<TKey>;
     }) => JSX.Element;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 export declare const createQuery: <TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown>(queryFn: (key: TKey, state: QueryState<TKey, TResponse, TData, TError>) => Promise<TResponse>, options?: CreateQueryOptions<TKey, TResponse, TData, TError>) => UseQuery<TKey, TResponse, TData, TError>;

package/esm/preact/create-query.js

@@ -32,6 +32,9 @@ const useQueryDefaultDeps = (state) => [
     state.isWaitingNextPage,
     state.hasNextPage,
 ];
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 export const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = noop, onSubscribe = noop, onLastUnsubscribe = noop, onBeforeChangeKey = noop, defaultDeps = useQueryDefaultDeps, select = identityFn, staleTime = 3000, // 3 seconds

package/esm/preact/create-store.d.ts

@@ -23,6 +23,9 @@ export type UseStore<T extends StoreData> = {
     setDefaultValues: (values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T>) => any;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 export declare const createStore: <T extends StoreData>(initializer: StoreInitializer<T>, options?: InitStoreOptions<T> & {
     defaultDeps?: SelectDeps<T>;
 }) => UseStore<T>;

package/esm/preact/create-store.js

@@ -1,5 +1,8 @@
 import { useEffect, useState } from 'preact/hooks';
 import { initStore, } from '../vanilla';
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 export const createStore = (initializer, options = {}) => {
     const { get, set, subscribe, getSubscribers } = initStore(initializer, options);
     const { defaultDeps } = options;

package/esm/preact/create-stores.d.ts

@@ -46,5 +46,8 @@ export type CreateStoresOptions<TKey extends StoreKey = StoreKey, T extends Stor
     defaultDeps?: SelectDeps<T>;
     hashKeyFn?: (obj: TKey) => string;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 export declare const createStores: <TKey extends StoreKey = StoreKey, T extends StoreData = StoreData>(initializer: StoresInitializer<TKey, T>, options?: CreateStoresOptions<TKey, T>) => UseStores<TKey, T>;
 export {};

package/esm/preact/create-stores.js

@@ -1,6 +1,9 @@
 import { useEffect, useMemo, useRef, useState } from 'preact/hooks';
 import { hashStoreKey, noop } from '../utils';
 import { initStore, } from '../vanilla';
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 export const createStores = (initializer, options = {}) => {
     const { onBeforeChangeKey = noop, onStoreInitialized = noop, defaultDeps, hashKeyFn = hashStoreKey, } = options;
     const stores = new Map();

package/esm/react/create-mutation.d.ts

@@ -33,4 +33,7 @@ export type CreateMutationOptions<TVar, TResponse = any, TError = unknown> = Ini
     onError?: (error: TError, variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
     onSettled?: (variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 export declare const createMutation: <TVar, TResponse = any, TError = unknown>(mutationFn: (variables: TVar, state: MutationState<TVar, TResponse, TError>) => Promise<TResponse>, options?: CreateMutationOptions<TVar, TResponse, TError>) => UseMutation<TVar, TResponse, TError>;

package/esm/react/create-mutation.js

@@ -1,5 +1,8 @@
 import { noop } from '../utils';
 import { createStore } from './create-store';
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 export const createMutation = (mutationFn, options = {}) => {
     const { onMutate = noop, onSuccess = noop, onError = noop, onSettled = noop, ...createStoreOptions } = options;
     const useMutation = createStore(({ set, get }) => ({

package/esm/react/create-query.d.ts

@@ -197,7 +197,9 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      *
      * Disabled by default.
      *
-     * If the query is on error state, the polling interval will be disabled, and it will use `retry` instead.
+     * If last data fetching is failed, the polling interval will be disabled, and it will use `retry` mechanism instead.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/polling
      */
     refetchInterval?: number | false | ((state: QueryState<TKey, TResponse, TData, TError>) => number | false);
 };
@@ -257,4 +259,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
         error?: FunctionComponent<TKey>;
     }) => JSX.Element;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 export declare const createQuery: <TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown>(queryFn: (key: TKey, state: QueryState<TKey, TResponse, TData, TError>) => Promise<TResponse>, options?: CreateQueryOptions<TKey, TResponse, TData, TError>) => UseQuery<TKey, TResponse, TData, TError>;

package/esm/react/create-query.js

@@ -31,6 +31,9 @@ const useQueryDefaultDeps = (state) => [
     state.isWaitingNextPage,
     state.hasNextPage,
 ];
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 export const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = noop, onSubscribe = noop, onLastUnsubscribe = noop, onBeforeChangeKey = noop, defaultDeps = useQueryDefaultDeps, select = identityFn, staleTime = 3000, // 3 seconds

package/esm/react/create-store.d.ts

@@ -23,6 +23,9 @@ export type UseStore<T extends StoreData> = {
     setDefaultValues: (values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T>) => any;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 export declare const createStore: <T extends StoreData>(initializer: StoreInitializer<T>, options?: InitStoreOptions<T> & {
     defaultDeps?: SelectDeps<T>;
 }) => UseStore<T>;

package/esm/react/create-store.js

@@ -1,5 +1,8 @@
 import { useEffect, useState } from 'react';
 import { initStore, } from '../vanilla';
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 export const createStore = (initializer, options = {}) => {
     const { get, set, subscribe, getSubscribers } = initStore(initializer, options);
     const { defaultDeps } = options;

package/esm/react/create-stores.d.ts

@@ -46,5 +46,8 @@ export type CreateStoresOptions<TKey extends StoreKey = StoreKey, T extends Stor
     defaultDeps?: SelectDeps<T>;
     hashKeyFn?: (obj: TKey) => string;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 export declare const createStores: <TKey extends StoreKey = StoreKey, T extends StoreData = StoreData>(initializer: StoresInitializer<TKey, T>, options?: CreateStoresOptions<TKey, T>) => UseStores<TKey, T>;
 export {};

package/esm/react/create-stores.js

@@ -1,6 +1,9 @@
 import { useEffect, useMemo, useRef, useState } from 'react';
 import { hashStoreKey, noop } from '../utils';
 import { initStore, } from '../vanilla';
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 export const createStores = (initializer, options = {}) => {
     const { onBeforeChangeKey = noop, onStoreInitialized = noop, defaultDeps, hashKeyFn = hashStoreKey, } = options;
     const stores = new Map();

package/lib/preact/create-mutation.d.ts

@@ -33,4 +33,7 @@ export type CreateMutationOptions<TVar, TResponse = any, TError = unknown> = Ini
     onError?: (error: TError, variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
     onSettled?: (variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 export declare const createMutation: <TVar, TResponse = any, TError = unknown>(mutationFn: (variables: TVar, state: MutationState<TVar, TResponse, TError>) => Promise<TResponse>, options?: CreateMutationOptions<TVar, TResponse, TError>) => UseMutation<TVar, TResponse, TError>;

package/lib/preact/create-mutation.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMutation = void 0;
 const utils_1 = require("../utils");
 const create_store_1 = require("./create-store");
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 const createMutation = (mutationFn, options = {}) => {
     const { onMutate = utils_1.noop, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, ...createStoreOptions } = options;
     const useMutation = (0, create_store_1.createStore)(({ set, get }) => ({

package/lib/preact/create-query.d.ts

@@ -198,7 +198,9 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      *
      * Disabled by default.
      *
-     * If the query is on error state, the polling interval will be disabled, and it will use `retry` instead.
+     * If last data fetching is failed, the polling interval will be disabled, and it will use `retry` mechanism instead.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/polling
      */
     refetchInterval?: number | false | ((state: QueryState<TKey, TResponse, TData, TError>) => number | false);
 };
@@ -258,4 +260,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
         error?: FunctionComponent<TKey>;
     }) => JSX.Element;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 export declare const createQuery: <TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown>(queryFn: (key: TKey, state: QueryState<TKey, TResponse, TData, TError>) => Promise<TResponse>, options?: CreateQueryOptions<TKey, TResponse, TData, TError>) => UseQuery<TKey, TResponse, TData, TError>;

package/lib/preact/create-query.js

@@ -35,6 +35,9 @@ const useQueryDefaultDeps = (state) => [
     state.isWaitingNextPage,
     state.hasNextPage,
 ];
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = utils_1.noop, onSubscribe = utils_1.noop, onLastUnsubscribe = utils_1.noop, onBeforeChangeKey = utils_1.noop, defaultDeps = useQueryDefaultDeps, select = utils_1.identityFn, staleTime = 3000, // 3 seconds

package/lib/preact/create-store.d.ts

@@ -23,6 +23,9 @@ export type UseStore<T extends StoreData> = {
     setDefaultValues: (values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T>) => any;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 export declare const createStore: <T extends StoreData>(initializer: StoreInitializer<T>, options?: InitStoreOptions<T> & {
     defaultDeps?: SelectDeps<T>;
 }) => UseStore<T>;

package/lib/preact/create-store.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStore = void 0;
 const hooks_1 = require("preact/hooks");
 const vanilla_1 = require("../vanilla");
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 const createStore = (initializer, options = {}) => {
     const { get, set, subscribe, getSubscribers } = (0, vanilla_1.initStore)(initializer, options);
     const { defaultDeps } = options;

package/lib/preact/create-stores.d.ts

@@ -46,5 +46,8 @@ export type CreateStoresOptions<TKey extends StoreKey = StoreKey, T extends Stor
     defaultDeps?: SelectDeps<T>;
     hashKeyFn?: (obj: TKey) => string;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 export declare const createStores: <TKey extends StoreKey = StoreKey, T extends StoreData = StoreData>(initializer: StoresInitializer<TKey, T>, options?: CreateStoresOptions<TKey, T>) => UseStores<TKey, T>;
 export {};

package/lib/preact/create-stores.js

@@ -4,6 +4,9 @@ exports.createStores = void 0;
 const hooks_1 = require("preact/hooks");
 const utils_1 = require("../utils");
 const vanilla_1 = require("../vanilla");
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 const createStores = (initializer, options = {}) => {
     const { onBeforeChangeKey = utils_1.noop, onStoreInitialized = utils_1.noop, defaultDeps, hashKeyFn = utils_1.hashStoreKey, } = options;
     const stores = new Map();

package/lib/react/create-mutation.d.ts

@@ -33,4 +33,7 @@ export type CreateMutationOptions<TVar, TResponse = any, TError = unknown> = Ini
     onError?: (error: TError, variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
     onSettled?: (variables: TVar, stateBeforeMutate: MutationState<TVar, TResponse, TError>) => void;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 export declare const createMutation: <TVar, TResponse = any, TError = unknown>(mutationFn: (variables: TVar, state: MutationState<TVar, TResponse, TError>) => Promise<TResponse>, options?: CreateMutationOptions<TVar, TResponse, TError>) => UseMutation<TVar, TResponse, TError>;

package/lib/react/create-mutation.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMutation = void 0;
 const utils_1 = require("../utils");
 const create_store_1 = require("./create-store");
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createmutation
+ */
 const createMutation = (mutationFn, options = {}) => {
     const { onMutate = utils_1.noop, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, ...createStoreOptions } = options;
     const useMutation = (0, create_store_1.createStore)(({ set, get }) => ({

package/lib/react/create-query.d.ts

@@ -197,7 +197,9 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
      *
      * Disabled by default.
      *
-     * If the query is on error state, the polling interval will be disabled, and it will use `retry` instead.
+     * If last data fetching is failed, the polling interval will be disabled, and it will use `retry` mechanism instead.
+     *
+     * @see https://floppy-disk.vercel.app/docs/query/polling
      */
     refetchInterval?: number | false | ((state: QueryState<TKey, TResponse, TData, TError>) => number | false);
 };
@@ -257,4 +259,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
         error?: FunctionComponent<TKey>;
     }) => JSX.Element;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 export declare const createQuery: <TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown>(queryFn: (key: TKey, state: QueryState<TKey, TResponse, TData, TError>) => Promise<TResponse>, options?: CreateQueryOptions<TKey, TResponse, TData, TError>) => UseQuery<TKey, TResponse, TData, TError>;

package/lib/react/create-query.js

@@ -34,6 +34,9 @@ const useQueryDefaultDeps = (state) => [
     state.isWaitingNextPage,
     state.hasNextPage,
 ];
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createquery
+ */
 const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = utils_1.noop, onSubscribe = utils_1.noop, onLastUnsubscribe = utils_1.noop, onBeforeChangeKey = utils_1.noop, defaultDeps = useQueryDefaultDeps, select = utils_1.identityFn, staleTime = 3000, // 3 seconds

package/lib/react/create-store.d.ts

@@ -23,6 +23,9 @@ export type UseStore<T extends StoreData> = {
     setDefaultValues: (values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T>) => any;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 export declare const createStore: <T extends StoreData>(initializer: StoreInitializer<T>, options?: InitStoreOptions<T> & {
     defaultDeps?: SelectDeps<T>;
 }) => UseStore<T>;

package/lib/react/create-store.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStore = void 0;
 const react_1 = require("react");
 const vanilla_1 = require("../vanilla");
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstore
+ */
 const createStore = (initializer, options = {}) => {
     const { get, set, subscribe, getSubscribers } = (0, vanilla_1.initStore)(initializer, options);
     const { defaultDeps } = options;

package/lib/react/create-stores.d.ts

@@ -46,5 +46,8 @@ export type CreateStoresOptions<TKey extends StoreKey = StoreKey, T extends Stor
     defaultDeps?: SelectDeps<T>;
     hashKeyFn?: (obj: TKey) => string;
 };
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 export declare const createStores: <TKey extends StoreKey = StoreKey, T extends StoreData = StoreData>(initializer: StoresInitializer<TKey, T>, options?: CreateStoresOptions<TKey, T>) => UseStores<TKey, T>;
 export {};

package/lib/react/create-stores.js

@@ -4,6 +4,9 @@ exports.createStores = void 0;
 const react_1 = require("react");
 const utils_1 = require("../utils");
 const vanilla_1 = require("../vanilla");
+/**
+ * @see https://floppy-disk.vercel.app/docs/api#createstores
+ */
 const createStores = (initializer, options = {}) => {
     const { onBeforeChangeKey = utils_1.noop, onStoreInitialized = utils_1.noop, defaultDeps, hashKeyFn = utils_1.hashStoreKey, } = options;
     const stores = new Map();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floppy-disk",
-  "version": "2.4.0-beta.3",
+  "version": "2.4.0",
   "description": "FloppyDisk - lightweight, simple, and powerful state management library",
   "keywords": [
     "state",