DocsOther

Other

28
Items
21
Functions
3
Types
4
Other

AIReview

property

Represents a detailed review of an AI tool with pros, cons, and verdict.

AITool

type

Represents an AI tool with its configuration and status.

Infer

boolean

function

Creates a boolean validation schema.

boolean(): Schema

Card

function

Versatile card component with optional title and column spanning. Supports both card and section variants from the theme system. Can display an optional title (string or ReactNode with icons) and span multiple grid columns.

Card(__namedParameters: CardProps): Element

CardGrid

function

Responsive card grid layout component. Provides a consistent grid system for card layouts with mobile-first responsive breakpoints. Default is 3 columns (1 on mobile, 2 on tablet, 3 on desktop).

CardGrid(__namedParameters: CardGridProps): Element

default

function

PageShell Component A standardized page layout component that provides consistent spacing and structure across all pages in the application.

default(__namedParameters: PageShellProps): Element

FavoriteModel

property

Represents a favorite AI model with its rating and review.

GET

function

Fetch currently playing music from ListenBrainz Returns the most recent listening data for the configured user. Requires LISTENBRAINZ_TOKEN environment variable to be set.

GET(): Promise

isActiveStatus

function

Type guard to check if AI tool status is active.

isActiveStatus(status: AIToolStatus): any

isInactiveStatus

function

Type guard to check if AI tool status is inactive.

isInactiveStatus(status: AIToolStatus): any

isInactiveTool

function

Type guard to check if AI tool is inactive.

isInactiveTool(tool: Simplify | Simplify): any

isSupportedModule

function

Checks if a file has a supported module extension.

isSupportedModule(fileName: string): boolean

isValidCheckDefinition

function

Type guard to validate check definition objects.

isValidCheckDefinition(value: unknown): any

loadRegistry

function

Loads and validates best-practice check modules.

loadRegistry(): Promise

MobileMenuProvider

function

Provider component for mobile menu state management.

MobileMenuProvider(props: object): Element

NowPlayingService

class

Service for fetching and caching real-time music playing data.

number

function

Creates a number validation schema.

number(options: NumberSchemaOptions = {}): Schema

parseCliArguments

function

Parses command line arguments for best-practices tool.

parseCliArguments(args: any): CliParseResult

Path

type

Represents a path in a nested object structure for validation error reporting.

string | number[]

resolveChecksToRun

function

Resolves which checks to run based on selection and skip sets.

resolveChecksToRun(selected: Set, skipped: Set, registry: CheckDefinition[]): CheckDefinition[]

runChecks

function

Executes an array of best-practice checks.

runChecks(checks: CheckDefinition[]): Promise

Section

function

Section component for content layout with consistent styling.

Section(props: SectionProps): Element

Simplify

type

Utility type to simplify complex mapped types by removing unnecessary intersections.

any

string

function

Creates a string validation schema.

string(options: StringSchemaOptions = {}): Schema

useMobileMenu

function

Combined hook for mobile menu state and dispatch.

useMobileMenu(): object

useMobileMenuDispatch

function

Hook for accessing mobile menu dispatch function.

useMobileMenuDispatch(): Dispatch

useMobileMenuState

function

Hook for accessing mobile menu state.

useMobileMenuState(): boolean

ValidationError

class

Custom error class for validation failures with detailed issue reporting.