Skip to main content

tieFormatGenderValidityCheck

8.0.0 engine API transition

This method is a candidate for removal from production governors and engine exports at 8.0.0. Its 7.x route has not been removed. Final removal and standalone package-export decisions require the per-method review and external-integrator confirmation described in the transition index.

Source-local contract​

The declaration below is copied from the pinned source revision; referenced types are defined there. It is an implementation signature, not a package import example.

export function tieFormatGenderValidityCheck(params: GenderValidityCheckArgs): ResultType;

Engine effects​

State writes: not yet assessed. Notices: not yet assessed. Governor query/mutate placement is not proof of purity; review the implementation and engine path before deciding exposure.

Consumer evidence​

The refreshed source-name scan found no name mentions in the scanned product source files. This does not establish external-integrator non-use. The manifest records repository revisions and scan exclusions. External-integrator confirmation is pending.

Availability and ownership​

  • Production governor declarations: queryGovernor, tieFormatGovernor.
  • Standalone package API after 8.0.0: decision pending; this page does not establish a supported import.
  • Implementation: src/validators/tieFormatGenderValidityCheck.ts — tieFormatGenderValidityCheck. Source paths and aliases are not package import paths.
  • Replacement workflow: not yet established; no supported replacement is promised.
  • Test-only adapters: may exercise this implementation independently of production engine exports; this is not evidence of product use.

Preserved 7.x reference​

The passages below preserve the existing governor documentation. Engine examples describe 7.x availability, not an 8.x replacement. Source contracts take precedence where an explicitly noted correction applies.

From governors/tie-format-governor.md​

Validates that a collection's gender specification is compatible with the reference gender (event or category gender).

const { valid, error, info } = engine.tieFormatGenderValidityCheck({
  referenceGender, // gender of event or category (e.g., 'MALE', 'FEMALE', 'MIXED', 'ANY')
  matchUpType, // 'SINGLES' or 'DOUBLES'
  gender, // gender of the collection being validated
});

if (!valid) {
  console.error(error, info);
}

Returns:

{
  valid: boolean;
  error?: ErrorType;  // INVALID_GENDER if validation fails
  info?: string;      // Explanation of validation failure
}

Validation rules:

  1. Gendered events (MALE/FEMALE): Collection gender must match reference gender
  2. MIXED events: Cannot contain MIXED singles (only MIXED doubles); cannot contain gender: ANY
  3. ANY gender events: Cannot contain MIXED singles (only MIXED doubles)