Skip to content

Commit

Permalink
Fix tsdoc inspections
Browse files Browse the repository at this point in the history
  • Loading branch information
hlysine committed Aug 19, 2023
1 parent f4b380d commit 03288d5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/helper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { RegExpLiteral } from './types';

/**
* Check whether a given value is a template strings array.
* @param arg The argument to check.
* @param arg - The argument to check.
* @returns Whether the argument is a template strings array.
*/
export function isTemplateStringsArray(arg: unknown): arg is TemplateStringsArray {
Expand All @@ -11,7 +11,7 @@ export function isTemplateStringsArray(arg: unknown): arg is TemplateStringsArra

/**
* Check whether the argument contains exactly one string in string or template form.
* @param args The argument to check.
* @param args - The argument to check.
* @returns Whether the argument contains exactly one string in string or template form.
*/
export function isLiteralArgument(args: unknown[]): args is RegExpLiteral {
Expand All @@ -26,8 +26,8 @@ export function isLiteralArgument(args: unknown[]): args is RegExpLiteral {

/**
* Get the literal string from a string or template string array.
* @param args Arguments passed to the function, either a string or a template string.
* @param escape Whether to escape the string.
* @param args - Arguments passed to the function, either a string or a template string.
* @param escape - Whether to escape the string.
* @returns The literal string.
*/
export function getLiteralString(args: RegExpLiteral, escape = true): string {
Expand All @@ -53,8 +53,8 @@ export function bind<T extends Function, U>(

/**
* Copy all properties from source to target, including those in the prototype chain of source.
* @param target The target object to which the properties will be added.
* @param source The source object from which the properties will be copied.
* @param target - The target object to which the properties will be added.
* @param source - The source object from which the properties will be copied.
* @returns The target object.
*/
export function assign<T extends Function, U>(target: T, source: U): T & U {
Expand Down

0 comments on commit 03288d5

Please sign in to comment.