• Preparing search index...
  • The search index is not available
@shopify/cli-kit
  • @shopify/cli-kit
  • common/string
  • pluralize

Function pluralize

  • pluralize<
        T,
        TToken extends Token = Token,
        TPluralToken extends Token = TToken,
        TSingularToken extends Token = TToken,
        TNoneToken extends Token = TToken,
    >(
        items: T[],
        plural: (items: T[]) => TokenItem<TPluralToken>,
        singular: (item: T) => TokenItem<TSingularToken>,
        none?: () => TokenItem<TNoneToken>,
    ): TokenItem<TPluralToken | TSingularToken | TNoneToken> | string
  • Given a list of items, it returns a pluralized string based on the amount of items.

    Type Parameters

    • T
    • TToken extends Token = Token
    • TPluralToken extends Token = TToken
    • TSingularToken extends Token = TToken
    • TNoneToken extends Token = TToken

    Parameters

    • items: T[]

      List of items.

    • plural: (items: T[]) => TokenItem<TPluralToken>

      Supplier used when the list of items has more than one item.

    • singular: (item: T) => TokenItem<TSingularToken>

      Supplier used when the list of items has a single item.

    • Optionalnone: () => TokenItem<TNoneToken>

      Supplier used when the list has no items.

    Returns TokenItem<TPluralToken | TSingularToken | TNoneToken> | string

    The TokenItem supplied by the plural, singular, or none functions.

    • Defined in packages/cli-kit/src/public/common/string.ts:202

Settings

Member Visibility
@shopify/cli-kit
  • Loading...

Generated using TypeDoc