Bridge Training
Bridge Core

Format

Formatting functions for contracts and display values.

Import from @workspace/bridge-core/format/*.

formatContract

Formats a DisplayContract object into its string representation.

import { formatContract } from '@workspace/bridge-core/format/contract';

formatContract({ level: 3, suit: 'NT', doubled: 'none' });  // '3NT'
formatContract({ level: 4, suit: 'S', doubled: 'X' });      // '4SX'
formatContract({ level: 6, suit: 'H', doubled: 'XX' });     // '6HXX'
formatContract(null);                                         // ''
FunctionDescription
formatContract(contract)Converts a DisplayContract to a string like '3NT' or '4SX'. Returns '' for null.

DisplayContract Type

Prop

Type

On this page