@elliemae/pui-app-sdk 5.41.2 → 5.42.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-app-sdk",
-  "version": "5.41.2",
+  "version": "5.42.0",
   "description": "ICE MT UI Platform Application SDK ",
   "sideEffects": [
     "*.css",

package/build/docs/assets/js/1ad86f56.f102fd5e.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[124],{7198(e,r,n){n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"api/variables/decorators","title":"decorators","description":"Type Declaration","source":"@site/docs/api/variables/decorators.md","sourceDirName":"api/variables","slug":"/api/variables/decorators","permalink":"/app-sdk/api/variables/decorators","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/decorators.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"createSideEffect","permalink":"/app-sdk/api/variables/createSideEffect"},"next":{"title":"endSession","permalink":"/app-sdk/api/variables/endSession"}}');var s=n(6070),i=n(5676);const l={},c="decorators",a={},d=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"class",id:"class",level:3},{value:"class.Mixins",id:"classmixins",level:4},{value:"Parameters",id:"parameters",level:5},{value:"constructors",id:"constructors",level:6},{value:"Returns",id:"returns",level:5},{value:"Example",id:"example",level:5},{value:"class.Singleton",id:"classsingleton",level:4},{value:"Type Parameters",id:"type-parameters",level:5},{value:"T",id:"t",level:6},{value:"Parameters",id:"parameters-1",level:5},{value:"type",id:"type",level:6},{value:"Returns",id:"returns-1",level:5},{value:"Example",id:"example-1",level:5},{value:"function",id:"function",level:3},{value:"function.AsyncSingleExecution",id:"functionasyncsingleexecution",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"_target",id:"_target",level:6},{value:"_propertyKey",id:"_propertykey",level:6},{value:"descriptor",id:"descriptor",level:6},{value:"Returns",id:"returns-2",level:5},{value:"Example",id:"example-2",level:5},{value:"Parameters",id:"parameters-3",level:5},{value:"_target",id:"_target-1",level:6},{value:"propertyKey",id:"propertykey",level:6},{value:"descriptor",id:"descriptor-1",level:6},{value:"Returns",id:"returns-3",level:5},{value:"Example",id:"example-3",level:5},{value:"function.Debounce",id:"functiondebounce",level:4},{value:"Parameters",id:"parameters-4",level:5},{value:"delay?",id:"delay",level:6},{value:"Returns",id:"returns-4",level:5},{value:"Example",id:"example-4",level:5},{value:"function.ImmutableArgs",id:"functionimmutableargs",level:4},{value:"Parameters",id:"parameters-5",level:5},{value:"_target",id:"_target-2",level:6},{value:"_propertyKey",id:"_propertykey-1",level:6},{value:"descriptor",id:"descriptor-2",level:6},{value:"Returns",id:"returns-5",level:5},{value:"Example",id:"example-5",level:5},{value:"function.Memoize",id:"functionmemoize",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"_target",id:"_target-3",level:6},{value:"_key",id:"_key",level:6},{value:"descriptor",id:"descriptor-3",level:6},{value:"Returns",id:"returns-6",level:5},{value:"Example",id:"example-6",level:5},{value:"function.MemoizeAsync",id:"functionmemoizeasync",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"_target",id:"_target-4",level:6},{value:"_propertyKey",id:"_propertykey-2",level:6},{value:"descriptor",id:"descriptor-4",level:6},{value:"Returns",id:"returns-7",level:5},{value:"Example",id:"example-7",level:5},{value:"function.MemoizeSingleArgPrimitive",id:"functionmemoizesingleargprimitive",level:4},{value:"Type Parameters",id:"type-parameters-1",level:5},{value:"T",id:"t-1",level:6},{value:"R",id:"r",level:6},{value:"Parameters",id:"parameters-8",level:5},{value:"_target",id:"_target-5",level:6},{value:"_propertyKey",id:"_propertykey-3",level:6},{value:"descriptor",id:"descriptor-5",level:6},{value:"Returns",id:"returns-8",level:5},{value:"Examples",id:"examples",level:5},{value:"function.QueueTask",id:"functionqueuetask",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"_target",id:"_target-6",level:6},{value:"_key",id:"_key-1",level:6},{value:"descriptor",id:"descriptor-6",level:6},{value:"Returns",id:"returns-9",level:5},{value:"Example",id:"example-8",level:5},{value:"function.RetryAsync",id:"functionretryasync",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"retries?",id:"retries",level:6},{value:"interval?",id:"interval",level:6},{value:"reThrowException?",id:"rethrowexception",level:6},{value:"Returns",id:"returns-10",level:5},{value:"Example",id:"example-9",level:5},{value:"function.Throttle",id:"functionthrottle",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"delay?",id:"delay-1",level:6},{value:"Returns",id:"returns-11",level:5},{value:"Example",id:"example-10",level:5}];function o(e){const r={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",h6:"h6",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"decorators",children:"decorators"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"const decorators: {\n  class: {\n     Mixins: (...constructors: any[]) => (derivedCtor: any) => void;\n     Singleton: <T>(type: T) => SingletonType;\n  };\n  function: {\n     AsyncSingleExecution: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     CacheUntilResolved: (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     Debounce: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     ImmutableArgs: (_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     Memoize: (_target: any, _key: string, descriptor: PropertyDescriptor) => void;\n     MemoizeAsync: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     MemoizeSingleArgPrimitive: <T, R>(_target: any, _propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => R>) => TypedPropertyDescriptor<(...args: any[]) => R>;\n     QueueTask: (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;\n     RetryAsync: (retries?: number, interval?: number, reThrowException?: boolean) => MethodDecorator;\n     Throttle: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  };\n};\n"})}),"\n",(0,s.jsx)(r.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,s.jsx)(r.h3,{id:"class",children:"class"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"class: {\n  Mixins: (...constructors: any[]) => (derivedCtor: any) => void;\n  Singleton: <T>(type: T) => SingletonType;\n};\n"})}),"\n",(0,s.jsx)(r.h4,{id:"classmixins",children:"class.Mixins"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Mixins: (...constructors: any[]) => (derivedCtor: any) => void;\n"})}),"\n",(0,s.jsx)(r.p,{children:"A decorator to mix multiple classes into a single class."}),"\n",(0,s.jsx)(r.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"constructors",children:"constructors"}),"\n",(0,s.jsxs)(r.p,{children:["...",(0,s.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(r.p,{children:"The constructors of the classes to be mixed in."}),"\n",(0,s.jsx)(r.h5,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:"A class decorator that mixes the provided classes into the target class."}),"\n",(0,s.jsxs)(r.p,{children:["(",(0,s.jsx)(r.code,{children:"derivedCtor"}),": ",(0,s.jsx)(r.code,{children:"any"}),") => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n",(0,s.jsx)(r.h5,{id:"example",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class A {\n  methodA() {\n    console.log('A');\n  }\n}\n\nclass B {\n  methodB() {\n    console.log('B');\n  }\n}\n// Apply decorator\n// @Mixins(A, B)\nclass C {}\n\nconst instance = new C();\ninstance.methodA(); // Outputs: 'A'\ninstance.methodB(); // Outputs: 'B'\n"})}),"\n",(0,s.jsx)(r.h4,{id:"classsingleton",children:"class.Singleton"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Singleton: <T>(type: T) => SingletonType;\n"})}),"\n",(0,s.jsx)(r.p,{children:"A decorator to make a class a singleton."}),"\n",(0,s.jsx)(r.h5,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"t",children:"T"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"T"})," ",(0,s.jsx)(r.em,{children:"extends"})," (...",(0,s.jsx)(r.code,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"any"}),"[]) => ",(0,s.jsx)(r.code,{children:"any"})]}),"\n",(0,s.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"type",children:"type"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"T"})}),"\n",(0,s.jsx)(r.p,{children:"The class to be made a singleton."}),"\n",(0,s.jsx)(r.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"SingletonType"})}),"\n",(0,s.jsx)(r.p,{children:"A proxy that ensures only one instance of the class is created."}),"\n",(0,s.jsx)(r.h5,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// @Singleton decorator\nclass MyClass {\n  constructor() {\n    console.log('Instance created');\n  }\n}\n\nconst instance1 = new MyClass(); // Outputs: 'Instance created'\nconst instance2 = new MyClass(); // No output, same instance returned\n\nconsole.log(instance1 === instance2); // Outputs: true\n"})}),"\n",(0,s.jsx)(r.h3,{id:"function",children:"function"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"function: {\n  AsyncSingleExecution: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  CacheUntilResolved: (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  Debounce: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  ImmutableArgs: (_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  Memoize: (_target: any, _key: string, descriptor: PropertyDescriptor) => void;\n  MemoizeAsync: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  MemoizeSingleArgPrimitive: <T, R>(_target: any, _propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => R>) => TypedPropertyDescriptor<(...args: any[]) => R>;\n  QueueTask: (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;\n  RetryAsync: (retries?: number, interval?: number, reThrowException?: boolean) => MethodDecorator;\n  Throttle: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n};\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionasyncsingleexecution",children:"function.AsyncSingleExecution"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"AsyncSingleExecution: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"AsyncSingleExecution decorator ensures that multiple concurrent calls to an async function\nwith the same arguments will return the same promise instance until it resolves.\nOnce resolved, subsequent calls will trigger a new execution."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey",children:"_propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.h6,{id:"descriptor",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.h5,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"A function that modifies the property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"import { AsyncSingleExecution } from './functionDecorators';\n\nclass Example {\n  @AsyncSingleExecution\n  async fetchData(id: number) {\n    console.log('Fetching data for', id);\n    return new Promise(resolve => setTimeout(() => resolve(id), 1000));\n  }\n}\n\nconst instance = new Example();\nconst promise1 = instance.fetchData(1);\nconst promise2 = instance.fetchData(1);\n\nconsole.log(promise1 === promise2); // true\n"})}),"\n",(0,s.jsx)(r.p,{children:"// Output:\n// Fetching data for 1 (only logged once)"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{children:"\n#### function.CacheUntilResolved\n\n```ts\nCacheUntilResolved: (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Caches the result of a method until the promise is resolved."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-1",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"propertykey",children:"propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-1",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: CacheUntilResolved\n  async fetchData() {\n    // ...fetch data...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functiondebounce",children:"function.Debounce"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Debounce: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Debounces the method call by the specified delay."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"delay",children:"delay?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"300"})]}),"\n",(0,s.jsx)(r.p,{children:"The delay in milliseconds."}),"\n",(0,s.jsx)(r.h5,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:"A function that modifies the property descriptor."}),"\n",(0,s.jsxs)(r.p,{children:["(",(0,s.jsx)(r.code,{children:"_target"}),": ",(0,s.jsx)(r.code,{children:"any"}),", ",(0,s.jsx)(r.code,{children:"_propertyKey"}),": ",(0,s.jsx)(r.code,{children:"string"}),", ",(0,s.jsx)(r.code,{children:"descriptor"}),": ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"}),") => ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"})]}),"\n",(0,s.jsx)(r.h5,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: Debounce(500)\n  onResize() {\n    // ...handle resize...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionimmutableargs",children:"function.ImmutableArgs"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"ImmutableArgs: (_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Makes the arguments of a method immutable."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-2",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey-1",children:"_propertyKey"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"string"})," | ",(0,s.jsx)(r.code,{children:"symbol"})]}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-2",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: ImmutableArgs\n  updateData(data: any) {\n    // ...update data...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionmemoize",children:"function.Memoize"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Memoize: (_target: any, _key: string, descriptor: PropertyDescriptor) => void;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Memoizes the result of a method."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-3",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_key",children:"_key"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-3",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: Memoize\n  computeValue(x: number) {\n    return x * 2;\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionmemoizeasync",children:"function.MemoizeAsync"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"MemoizeAsync: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Memoizes the result of an async method."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-4",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey-2",children:"_propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-4",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: MemoizeAsync\n  async fetchData() {\n    // ...fetch data...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionmemoizesingleargprimitive",children:"function.MemoizeSingleArgPrimitive"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"MemoizeSingleArgPrimitive: <T, R>(_target: any, _propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => R>) => TypedPropertyDescriptor<(...args: any[]) => R>;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Memoizes the result of a function with a single primitive argument or no arguments.\nOnly caches results for functions that take exactly one primitive argument (string, number, boolean, symbol, null, or undefined)\nor no arguments at all. Uses a simple object as the cache."}),"\n",(0,s.jsx)(r.h5,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"t-1",children:"T"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"T"})," ",(0,s.jsx)(r.em,{children:"extends"})," ",(0,s.jsx)(r.code,{children:"string"})," | ",(0,s.jsx)(r.code,{children:"number"})," | ",(0,s.jsx)(r.code,{children:"boolean"})," | ",(0,s.jsx)(r.code,{children:"symbol"})," | ",(0,s.jsx)(r.code,{children:"null"})," | ",(0,s.jsx)(r.code,{children:"undefined"})]}),"\n",(0,s.jsx)(r.h6,{id:"r",children:"R"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"R"})}),"\n",(0,s.jsx)(r.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-5",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey-3",children:"_propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-5",children:"descriptor"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"TypedPropertyDescriptor"}),"<(...",(0,s.jsx)(r.code,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"any"}),"[]) => ",(0,s.jsx)(r.code,{children:"R"}),">"]}),"\n",(0,s.jsx)(r.h5,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"TypedPropertyDescriptor"}),"<(...",(0,s.jsx)(r.code,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"any"}),"[]) => ",(0,s.jsx)(r.code,{children:"R"}),">"]}),"\n",(0,s.jsx)(r.h5,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// Single primitive argument\nclass Example {\n  // Apply decorator: MemoizeSingleArgPrimitive\n  double(x: number) {\n    return x * 2;\n  }\n}\nconst ex = new Example();\nex.double(2); // Calls original, returns 4\nex.double(2); // Returns cached result, 4\n"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// No arguments\nclass ExampleNoArg {\n  // Apply decorator: MemoizeSingleArgPrimitive\n  getRandom() {\n    return Math.random();\n  }\n}\nconst ex2 = new ExampleNoArg();\nex2.getRandom(); // Calls original, returns a value\nex2.getRandom(); // Returns cached value\n"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// Not cached for non-primitive or multiple arguments\nclass ExampleObj {\n  // Apply decorator: MemoizeSingleArgPrimitive\n  sum(obj: { x: number }) {\n    return obj.x + 1;\n  }\n}\nconst ex3 = new ExampleObj();\nex3.sum({ x: 1 }); // Calls original\nex3.sum({ x: 1 }); // Calls original again (not cached)\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionqueuetask",children:"function.QueueTask"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"QueueTask: (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Queues the method call as a microtask."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-6",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"unknown"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_key-1",children:"_key"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-6",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: QueueTask\n  processTask() {\n    // ...process task...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionretryasync",children:"function.RetryAsync"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"RetryAsync: (retries?: number, interval?: number, reThrowException?: boolean) => MethodDecorator;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Retries an async method a specified number of times with a delay between attempts."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"retries",children:"retries?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"3"})]}),"\n",(0,s.jsx)(r.p,{children:"The number of retry attempts."}),"\n",(0,s.jsx)(r.h6,{id:"interval",children:"interval?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"2000"})]}),"\n",(0,s.jsx)(r.p,{children:"The delay in milliseconds between retries."}),"\n",(0,s.jsx)(r.h6,{id:"rethrowexception",children:"reThrowException?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"boolean"})," = ",(0,s.jsx)(r.code,{children:"true"})]}),"\n",(0,s.jsx)(r.p,{children:"Whether to rethrow the exception after all retries fail."}),"\n",(0,s.jsx)(r.h5,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"MethodDecorator"})}),"\n",(0,s.jsx)(r.p,{children:"A method decorator that modifies the property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"class Example {\n  @RetryAsync(3, 1000, true)\n  async fetchData() {\n    console.log('Attempting to fetch data...');\n    if (Math.random() < 0.7) {\n      throw new Error('Fetch failed');\n    }\n    return 'Data fetched successfully';\n  }\n}\n\nconst instance = new Example();\ninstance.fetchData().then(console.log).catch(console.error);\n\n// Output (example):\n// Attempting to fetch data...\n// Attempting to fetch data...\n// Attempting to fetch data...\n// Error: Fetch failed\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionthrottle",children:"function.Throttle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Throttle: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Throttles the method call by the specified delay."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"delay-1",children:"delay?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"300"})]}),"\n",(0,s.jsx)(r.p,{children:"The delay in milliseconds."}),"\n",(0,s.jsx)(r.h5,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:"A function that modifies the property descriptor."}),"\n",(0,s.jsxs)(r.p,{children:["(",(0,s.jsx)(r.code,{children:"_target"}),": ",(0,s.jsx)(r.code,{children:"any"}),", ",(0,s.jsx)(r.code,{children:"_propertyKey"}),": ",(0,s.jsx)(r.code,{children:"string"}),", ",(0,s.jsx)(r.code,{children:"descriptor"}),": ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"}),") => ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"})]}),"\n",(0,s.jsx)(r.h5,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"class Example {\n  @Throttle(500)\n  onScroll() {\n    // ...handle scroll...\n  }\n}\n"})})]})}function p(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},5676(e,r,n){n.d(r,{R:()=>l,x:()=>c});var t=n(758);const s={},i=t.createContext(s);function l(e){const r=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]);