feat: add eslint-plugin-tsdoc (#430)
* feat: add eslint-plugin-tsdoc * feat(doc): update current jsdoc to tsdoc specification * chore: update deps * feat: update warn to error for jsdoc and tsdoc * chore(doc): lint
This commit is contained in:
@@ -5,8 +5,9 @@ import type { Serialized } from 'chrome-extension-toolkit';
|
||||
|
||||
/**
|
||||
* Creates a new schedule with the given name
|
||||
* @param scheduleName the name of the schedule to create
|
||||
* @returns undefined if successful, otherwise an error message
|
||||
*
|
||||
* @param scheduleName - The name of the schedule to create
|
||||
* @returns Undefined if successful, otherwise an error message
|
||||
*/
|
||||
export default async function createSchedule(scheduleName: string) {
|
||||
const schedules = await UserScheduleStore.get('schedules');
|
||||
|
||||
@@ -5,8 +5,9 @@ import handleDuplicate from './handleDuplicate';
|
||||
|
||||
/**
|
||||
* Creates a new schedule with the given name
|
||||
* @param scheduleName the name of the schedule to create
|
||||
* @returns undefined if successful, otherwise an error message
|
||||
*
|
||||
* @param scheduleName - The name of the schedule to create
|
||||
* @returns Undefined if successful, otherwise an error message
|
||||
*/
|
||||
export default async function duplicateSchedule(scheduleId: string): Promise<string | undefined> {
|
||||
const schedules = await UserScheduleStore.get('schedules');
|
||||
|
||||
@@ -3,9 +3,10 @@ import { UserScheduleStore } from '@shared/storage/UserScheduleStore';
|
||||
/**
|
||||
* Duplicates a new schedule with the given name.
|
||||
* Assumes that each schedule has a unique name.
|
||||
* @param scheduleName the name of the schedule to handle duplication for
|
||||
* @param schedules the list of UserSchedules to find existing names
|
||||
* @returns the new name for the schedule, of the form `{baseName}({index})`
|
||||
*
|
||||
* @param scheduleName - The name of the schedule to handle duplication for
|
||||
* @param schedules - The list of UserSchedules to find existing names
|
||||
* @returns The new name for the schedule, of the form `{baseName}({index})`
|
||||
*/
|
||||
export default async function handleDuplicate(scheduleName: string): Promise<string> {
|
||||
const schedules = await UserScheduleStore.get('schedules');
|
||||
|
||||
Reference in New Issue
Block a user