validateSheetName | @sheetwrite/core

Validate and canonicalize a SpreadsheetML worksheet name.

Package: @sheetwrite/core
Source: packages/core/src/sheet-name.ts#L17

Declaration

function validateSheetName(
  name: string,
  existingNames?: readonly string[],
): SheetNameValidationResulttype SheetNameValidationResult =
  | {
      readonly ok: true;
      readonly name: string;
      readonly key: string;
    }
  | {
      readonly ok: false;
      readonly code: SheetNameIssueCode;
      readonly name: string;
      readonly key: string;
    };type SheetNameValidationResult =
  | {
      readonly ok: true;
      readonly name: string;
      readonly key: string;
    }
  | {
      readonly ok: false;
      readonly code: SheetNameIssueCode;
      readonly name: string;
      readonly key: string;
    };type SheetNameValidationResult =
  | {
      readonly ok: true;
      readonly name: string;
      readonly key: string;
    }
  | {
      readonly ok: false;
      readonly code: SheetNameIssueCode;
      readonly name: string;
      readonly key: string;
    };Successful canonical name or an actionable validation failure.API reference →