Skip to content
Sheetwrite

Sheetwrite / Documentation

SheetNameValidationResult@sheetwrite/core

Successful canonical name or an actionable validation failure.
@sheetwrite/coretype

Successful canonical name or an actionable validation failure.

Package
@sheetwrite/core
Source
packages/core/src/types/document.ts#L24

Variants 2

{
  readonly ok: true;
  readonly name: string;
  readonly key: string;
}
{
  readonly ok: false;
  readonly code: SheetNameIssueCode;
  readonly name: string;
  readonly key: string;
}

Declaration

View full TypeScript declaration 
export type SheetNameValidationResult =
  | {
      readonly ok: true;
      readonly name: string;
      readonly key: string;
    }
  | {
      readonly ok: false;
      readonly code: SheetNameIssueCode;
      readonly name: string;
      readonly key: string;
    };