Mark new types as alpha

Author: markerikson

etc/redux-toolkit.api.md

@@ -77,7 +77,7 @@ export type CaseReducerWithPrepare<State, Action extends PayloadAction> = {
     prepare: PrepareAction<Action['payload']>;
 };
 
-// @public (undocumented)
+// @alpha (undocumented)
 export type Comparer<T> = ComparerNum<T> | ComparerStr<T>;
 
 // @public
@@ -101,7 +101,7 @@ export function createAction<P = void, T extends string = string>(type: T): Payl
 // @public
 export function createAction<PA extends PrepareAction<any>, T extends string = string>(type: T, prepareAction: PA): PayloadActionCreator<ReturnType<PA>['payload'], T, PA>;
 
-// @public (undocumented)
+// @alpha (undocumented)
 export function createAsyncThunk<ActionType extends string, PayloadCreator extends AsyncActionCreator<unknown, Dispatch, unknown, undefined>>(type: ActionType, payloadCreator: PayloadCreator): {
     (args?: Parameters<PayloadCreator>[0]["args"] | undefined): (dispatch: any, getState: any, extra: any) => Promise<any>;
     pending: ActionCreatorWithPayload<{
@@ -120,7 +120,7 @@ export function createAsyncThunk<ActionType extends string, PayloadCreator exten
     }, string>;
 };
 
-// @public (undocumented)
+// @alpha (undocumented)
 export function createEntityAdapter<T>(options?: {
     selectId?: IdSelector<T>;
     sortComparer?: false | Comparer<T>;
@@ -150,7 +150,7 @@ export interface CreateSliceOptions<State = any, CR extends SliceCaseReducers<St
     reducers: ValidateSliceCaseReducers<State, CR>;
 }
 
-// @public (undocumented)
+// @alpha (undocumented)
 export abstract class Dictionary<T> implements DictionaryNum<T> {
     // (undocumented)
     [id: string]: T | undefined;
@@ -163,7 +163,7 @@ export interface EnhancedStore<S = any, A extends Action = AnyAction, M extends
     dispatch: DispatchForMiddlewares<M> & Dispatch<A>;
 }
 
-// @public (undocumented)
+// @alpha (undocumented)
 export interface EntityAdapter<T> extends EntityStateAdapter<T> {
     // (undocumented)
     getInitialState(): EntityState<T>;
@@ -179,10 +179,10 @@ export interface EntityAdapter<T> extends EntityStateAdapter<T> {
     sortComparer: false | Comparer<T>;
 }
 
-// @public (undocumented)
+// @alpha (undocumented)
 export type EntityMap<T> = (entity: T) => T;
 
-// @public (undocumented)
+// @alpha (undocumented)
 export interface EntityState<T> {
     // (undocumented)
     entities: Dictionary<T>;
@@ -203,7 +203,7 @@ export function getDefaultMiddleware<S = any, O extends Partial<GetDefaultMiddle
 // @public
 export function getType<T extends string>(actionCreator: PayloadActionCreator<any, T>): T;
 
-// @public (undocumented)
+// @alpha (undocumented)
 export type IdSelector<T> = IdSelectorStr<T> | IdSelectorNum<T>;
 
 // @public
@@ -222,7 +222,7 @@ export type PayloadAction<P = void, T extends string = string, M = never, E = ne
 // @public
 export type PayloadActionCreator<P = void, T extends string = string, PA extends PrepareAction<P> | void = void> = IfPrepareActionMethodProvided<PA, _ActionCreatorWithPreparedPayload<PA, T>, IsAny<P, ActionCreatorWithPayload<any, T>, IsUnknownOrNonInferrable<P, ActionCreatorWithNonInferrablePayload<T>, IfVoid<P, ActionCreatorWithoutPayload<T>, IfMaybeUndefined<P, ActionCreatorWithOptionalPayload<P, T>, ActionCreatorWithPayload<P, T>>>>>>;
 
-// @public (undocumented)
+// @alpha (undocumented)
 export type Predicate<T> = (entity: T) => boolean;
 
 // @public
@@ -266,7 +266,7 @@ export type SliceCaseReducers<State> = {
 
 export { ThunkAction }
 
-// @public (undocumented)
+// @alpha (undocumented)
 export type Update<T> = UpdateStr<T> | UpdateNum<T>;
 
 // @public

src/createAsyncThunk.ts

@@ -26,6 +26,13 @@ export type AsyncActionCreator<
   E extends unknown
 > = (params: AsyncThunkParams<A, D, S, E>) => any
 
+/**
+ *
+ * @param type
+ * @param payloadCreator
+ *
+ * @alpha
+ */
 export function createAsyncThunk<
   ActionType extends string,
   PayloadCreator extends AsyncActionCreator<

src/entities/create_adapter.ts

@@ -4,6 +4,12 @@ import { createSelectorsFactory } from './state_selectors'
 import { createSortedStateAdapter } from './sorted_state_adapter'
 import { createUnsortedStateAdapter } from './unsorted_state_adapter'
 
+/**
+ *
+ * @param options
+ *
+ * @alpha
+ */
 export function createEntityAdapter<T>(
   options: {
     selectId?: IdSelector<T>

src/entities/models.ts

@@ -3,17 +3,26 @@ import { PayloadAction } from '../createAction'
 export type ComparerStr<T> = (a: T, b: T) => string
 export type ComparerNum<T> = (a: T, b: T) => number
 
+/**
+ * @alpha
+ */
 export type Comparer<T> = ComparerNum<T> | ComparerStr<T>
 
 export type IdSelectorStr<T> = (model: T) => string
 export type IdSelectorNum<T> = (model: T) => number
 
+/**
+ * @alpha
+ */
 export type IdSelector<T> = IdSelectorStr<T> | IdSelectorNum<T>
 
 export interface DictionaryNum<T> {
   [id: number]: T | undefined
 }
 
+/**
+ * @alpha
+ */
 export abstract class Dictionary<T> implements DictionaryNum<T> {
   [id: string]: T | undefined
 }
@@ -28,14 +37,26 @@ export interface UpdateNum<T> {
   changes: Partial<T>
 }
 
+/**
+ * @alpha
+ */
 export type Update<T> = UpdateStr<T> | UpdateNum<T>
 
+/**
+ * @alpha
+ */
 export type Predicate<T> = (entity: T) => boolean
 
+/**
+ * @alpha
+ */
 export type EntityMap<T> = (entity: T) => T
 
 export type TypeOrPayloadAction<T> = T | PayloadAction<T>
 
+/**
+ * @alpha
+ */
 export interface EntityState<T> {
   ids: string[] | number[]
   entities: Dictionary<T>
@@ -111,6 +132,9 @@ export interface EntitySelectors<T, V> {
   selectTotal: (state: V) => number
 }
 
+/**
+ * @alpha
+ */
 export interface EntityAdapter<T> extends EntityStateAdapter<T> {
   selectId: IdSelector<T>
   sortComparer: false | Comparer<T>