Browse Source

docs: updates README.md

e22m4u 1 week ago
parent
commit
8dfef7bfb4
2 changed files with 23 additions and 25 deletions
  1. 18 20
      README.md
  2. 5 5
      src/create-spies-group.d.ts

+ 18 - 20
README.md

@@ -199,20 +199,19 @@ console.log(loggerSpy.isCalled);
 
 
 Сигнатуры вызова и аргументы:
 Сигнатуры вызова и аргументы:
 
 
-1. Отслеживание отдельной функции:  
-    `createSpy(targetFn, [customImplementation])`
+1.  Отслеживание отдельной функции:  
+    `createSpy(targetFn, [customImpl])`
     - `targetFn`: Функция, которую требуется отслеживать.
     - `targetFn`: Функция, которую требуется отслеживать.
-    - `customImplementation` (необязательно): Пользовательская функция,
+    - `customImpl` (необязательно): Пользовательская функция,
       которая будет вызываться вместо `targetFn`. Должна иметь ту же
       которая будет вызываться вместо `targetFn`. Должна иметь ту же
       сигнатуру.
       сигнатуру.
-  
-  
-2. Отслеживание метода объекта:  
-    `createSpy(targetObject, methodName, [customImplementation])`
+
+2.  Отслеживание метода объекта:  
+    `createSpy(targetObject, methodName, [customImpl])`
     - `targetObject`: Объект, метод которого будет отслеживаться.
     - `targetObject`: Объект, метод которого будет отслеживаться.
     - `methodName`: Имя метода в `targetObject`, который требуется
     - `methodName`: Имя метода в `targetObject`, который требуется
       отслеживать.
       отслеживать.
-    - `customImplementation` (необязательно): Пользовательская функция,
+    - `customImpl` (необязательно): Пользовательская функция,
       которая будет вызываться вместо оригинального метода. Должна
       которая будет вызываться вместо оригинального метода. Должна
       иметь ту же сигнатуру.
       иметь ту же сигнатуру.
 
 
@@ -242,8 +241,8 @@ console.log(spy.callCount); // 1
 
 
 #### spy.calls
 #### spy.calls
 
 
-- **Тип:** `CallInfo[]` (только для чтения)
-- **Описание:** Возвращает массив вызовов.
+- Тип: `CallInfo[]` (только для чтения)
+- Описание: Возвращает массив вызовов.
 
 
 ```js
 ```js
 const fn = (a, b) => a + b;
 const fn = (a, b) => a + b;
@@ -271,8 +270,8 @@ console.log(spy.calls);
 
 
 #### spy.isCalled
 #### spy.isCalled
 
 
-- **Тип:** `boolean` (только для чтения)
-- **Описание:** Указывает, был ли шпион вызван хотя бы один раз.
+- Тип: `boolean` (только для чтения)
+- Описание: Указывает, был ли шпион вызван хотя бы один раз.
 
 
 ```js
 ```js
 const spy = createSpy();
 const spy = createSpy();
@@ -283,8 +282,8 @@ console.log(spy.isCalled); // true
 
 
 #### spy.callCount
 #### spy.callCount
 
 
-- **Тип:** `number` (только для чтения)
-- **Описание:** Количество раз, которое шпион был вызван.
+- Тип: `number` (только для чтения)
+- Описание: Количество раз, которое шпион был вызван.
 
 
 ```js
 ```js
 const spy = createSpy();
 const spy = createSpy();
@@ -339,10 +338,6 @@ console.log(fnSpy.callCount); // 0 (история сброшена)
 
 
 Фабричная функция для создания экземпляра `SpiesGroup`.
 Фабричная функция для создания экземпляра `SpiesGroup`.
 
 
-Возвращает:
-
-- Новый экземпляр `SpiesGroup`.
-
 ```js
 ```js
 import {createSpiesGroup} from '@e22m4u/js-spy';
 import {createSpiesGroup} from '@e22m4u/js-spy';
 
 
@@ -360,8 +355,11 @@ const group = createSpiesGroup();
 
 
 Сигнатуры вызова и аргументы идентичны `createSpy`:
 Сигнатуры вызова и аргументы идентичны `createSpy`:
 
 
-1. `group.on(targetFn, [customImplementation])`
-2. `group.on(targetObject, methodName, [customImplementation])`
+1.  Отслеживание отдельной функции:  
+    `group.on(targetFn, [customImpl])`
+
+2.  Отслеживание метода объекта:  
+    `group.on(targetObject, methodName, [customImpl])`
 
 
 Возвращает:
 Возвращает:
 
 

+ 5 - 5
src/create-spies-group.d.ts

@@ -18,11 +18,11 @@ export declare class SpiesGroup {
    * и добавляет его в группу.
    * и добавляет его в группу.
    *
    *
    * @param target
    * @param target
-   * @param customImplementation
+   * @param customImpl
    */
    */
   on<TFunc extends AnyCallable>(
   on<TFunc extends AnyCallable>(
     target: TFunc,
     target: TFunc,
-    customImplementation?: TFunc,
+    customImpl?: TFunc,
   ): Spy<TFunc>;
   ): Spy<TFunc>;
 
 
   /**
   /**
@@ -31,13 +31,13 @@ export declare class SpiesGroup {
    * объекта шпионом.
    * объекта шпионом.
    *
    *
    * @param target
    * @param target
-   * @param methodNameOrImpl
-   * @param customImplForMethod
+   * @param methodName
+   * @param customImpl
    */
    */
   on<TObj extends object, K extends MethodKey<TObj>>(
   on<TObj extends object, K extends MethodKey<TObj>>(
     target: TObj,
     target: TObj,
     methodName: K,
     methodName: K,
-    customImplForMethod?: TObj[K],
+    customImpl?: TObj[K],
   ): Spy<Extract<TObj[K], AnyCallable>>;
   ): Spy<Extract<TObj[K], AnyCallable>>;
 
 
   /**
   /**