ngx-lift 0.5.0 → 1.1.0

package/lib/signals/create-notifier.d.ts

@@ -0,0 +1,4 @@
+export declare function createNotifier(): {
+    notify: () => void;
+    listen: import("@angular/core").Signal<number>;
+};

package/lib/signals/index.d.ts

@@ -0,0 +1,5 @@
+export * from './combine-from';
+export * from './computed-async';
+export * from './create-notifier';
+export * from './inject-params';
+export * from './inject-query-params';

package/lib/signals/inject-params.d.ts

@@ -0,0 +1,18 @@
+import { type Signal } from '@angular/core';
+import { type Params } from '@angular/router';
+/**
+ * Injects the params from the current route.
+ * If a key is provided, returns the value of that key.
+ * If a transform function is provided, returns the result of the function.
+ * Otherwise, returns the entire params object.
+ *
+ * @example
+ * const userId = injectParams('id'); // Returns the value of the 'id' param
+ * const userId = injectParams(p => p['id'] as string); // Returns the 'id' param using a custom transform function
+ * const params = injectParams(); // Returns the entire params object
+ *
+ * @param keyOrTransform OPTIONAL The key of the param to return, or a transform function to apply to the params object
+ */
+export declare function injectParams(): Signal<Params>;
+export declare function injectParams(key: string): Signal<string | null>;
+export declare function injectParams<T>(transform: (params: Params) => T): Signal<T>;

package/lib/signals/inject-query-params.d.ts

@@ -0,0 +1,71 @@
+import { type Signal } from '@angular/core';
+import { type Params } from '@angular/router';
+type QueryParamsTransformFn<Output> = (params: Params) => Output;
+/**
+ * The `InputOptions` interface defines options for configuring the behavior of the `injectQueryParams` function.
+ *
+ * @template Output - The expected type of the read value.
+ */
+export interface QueryParamsOptions<Output> {
+    /**
+     * A transformation function to convert the written value to the expected read value.
+     *
+     * @param v - The value to transform.
+     * @returns The transformed value.
+     */
+    transform?: (v: string) => Output;
+    /**
+     * The initial value to use if the query parameter is not present or undefined.
+     */
+    initialValue?: Output;
+}
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ *
+ * @returns A `Signal` that emits the entire query parameters object.
+ */
+export declare function injectQueryParams(): Signal<Params>;
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ *
+ * @param {string} key - The name of the query parameter to retrieve.
+ * @returns {Signal} A `Signal` that emits the value of the specified query parameter, or `null` if it's not present.
+ */
+export declare function injectQueryParams(key: string): Signal<string | null>;
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ *
+ * @param {string} key - The name of the query parameter to retrieve.
+ * @param {QueryParamsOptions} options - Optional configuration options for the query parameter.
+ * @returns {Signal} A `Signal` that emits the transformed value of the specified query parameter, or `null` if it's not present.
+ */
+export declare function injectQueryParams(key?: string, options?: QueryParamsOptions<boolean>): Signal<boolean | null>;
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ *
+ * @param {string} key - The name of the query parameter to retrieve.
+ * @param {QueryParamsOptions} options - Optional configuration options for the query parameter.
+ * @returns {Signal} A `Signal` that emits the transformed value of the specified query parameter, or `null` if it's not present.
+ */
+export declare function injectQueryParams(key?: string, options?: QueryParamsOptions<number>): Signal<number | null>;
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ *
+ * @param {string} key - The name of the query parameter to retrieve.
+ * @param {QueryParamsOptions} options - Optional configuration options for the query parameter.
+ * @returns {Signal} A `Signal` that emits the transformed value of the specified query parameter, or `null` if it's not present.
+ */
+export declare function injectQueryParams(key?: string, options?: QueryParamsOptions<string>): Signal<string | null>;
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ * It retrieves the value of a query parameter based on a custom transform function applied to the query parameters object.
+ *
+ * @template Output - The expected type of the read value.
+ * @param {QueryParamsTransformFn<Output>} fn - A transform function that takes the query parameters object (`params: Params`) and returns the desired value.
+ * @returns {Signal} A `Signal` that emits the transformed value based on the provided custom transform function.
+ *
+ * @example
+ * const searchValue = injectQueryParams((params) => params['search'] as string);
+ */
+export declare function injectQueryParams<Output>(fn: QueryParamsTransformFn<Output>): Signal<Output>;
+export {};

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "ngx-lift",
-  "version": "0.5.0",
+  "version": "1.1.0",
   "description": "A project has been crafted with the goal of enhancing and simplifying your Angular development experience.",
   "author": "Guanghui Wang <guanghui-wang@foxmail.com>",
   "peerDependencies": {
-    "@angular/common": ">=15.0.0",
-    "@angular/core": ">=15.0.0",
+    "@angular/common": ">=17.0.0",
+    "@angular/core": ">=17.0.0",
     "rxjs": ">=7.8.0"
   },
   "dependencies": {

package/public-api.d.ts

@@ -1,5 +1,6 @@
 export * from './lib/models';
 export * from './lib/operators';
 export * from './lib/pipes';
+export * from './lib/signals';
 export * from './lib/utils';
 export * from './lib/validators';