Variable posConst

Type Declaration

• Functionenum: <
      const T extends readonly string[],
      P extends
          Omit<EnumPositional<T[number]>, "type" | "choices"> = Omit<
          EnumPositional<T[number]>,
          "type" | "choices",
      >,
  >(
      choices: T,
      props?: P,
  ) => EnumPositional<T[number]> & P

  Define an enum positional argument with string choices.

• Functionnumber: <P extends Omit<NumberPositional, "type"> = Omit<NumberPositional, "type">>(
      props?: P,
  ) => NumberPositional & P

  Define a number positional argument.

• positionals: {
      <A extends PositionalDef>(
          a: A,
      ): CallablePositionalsParser<
          readonly [
              (
                  A extends PositionalDef
                      ? readonly [InferPositional<A<A>>]
                      : readonly []
              )[0],
          ],
      >;
      <A extends PositionalDef, B extends PositionalDef>(
          a: A,
          b: B,
      ): CallablePositionalsParser<
          A extends PositionalDef
              ? [B] extends PositionalsSchema
                  ? readonly [
                      InferPositional<A<A>>,
                      B extends PositionalDef
                          ? readonly [InferPositional<B<B>>]
                          : readonly [],
                  ]
                  : readonly [InferPositional<A<A>>]
              : readonly [],
      >;
      <A extends PositionalDef, B extends PositionalDef, C extends PositionalDef>(
          a: A,
          b: B,
          c: C,
      ): CallablePositionalsParser<
          A extends PositionalDef
              ? [B, C] extends PositionalsSchema
                  ?
                      | readonly [
                          InferPositional<A<A>>,
                          B extends PositionalDef
                              ? readonly [InferPositional<B<(...)>>]
                              : readonly [],
                      ]
                      | readonly [
                          InferPositional<A<A>>,
                          C extends PositionalDef
                              ? readonly [InferPositional<C<(...)>>]
                              : readonly [],
                      ]
                  : readonly [InferPositional<A<A>>]
              : readonly [],
      >;
      <
          A extends PositionalDef,
          B extends PositionalDef,
          C extends PositionalDef,
          D extends PositionalDef,
      >(
          a: A,
          b: B,
          c: C,
          d: D,
      ): CallablePositionalsParser<
          A extends PositionalDef
              ? [B, C, D] extends PositionalsSchema
                  ?
                      | readonly [
                          InferPositional<A<A>>,
                          B extends PositionalDef
                              ? readonly [InferPositional<B<(...)>>]
                              : readonly [],
                      ]
                      | readonly [
                          InferPositional<A<A>>,
                          C extends PositionalDef
                              ? readonly [InferPositional<C<(...)>>]
                              : readonly [],
                      ]
                      | readonly [
                          InferPositional<A<A>>,
                          D extends PositionalDef
                              ? readonly [InferPositional<D<(...)>>]
                              : readonly [],
                      ]
                  : readonly [InferPositional<A<A>>]
              : readonly [],
      >;
      (
          ...positionals: PositionalDef[],
      ): CallablePositionalsParser<readonly unknown[]>;
  }

  Create a Parser from positional definitions.

  Example

  const parser = pos.positionals(
    pos.string({ name: 'input', required: true }),
    pos.string({ name: 'output' }),
  );
  // Type: Parser<{}, readonly [string, string | undefined]>
  Copy

• Functionstring: <P extends Omit<StringPositional, "type"> = Omit<StringPositional, "type">>(
      props?: P,
  ) => P & StringPositional

  Define a string positional argument.

• Functionvariadic: (
      items: "string" | "number",
      props?: Omit<VariadicPositional, "items" | "type">,
  ) => VariadicPositional

  Define a variadic positional (rest args).