• Preparing search index...
  • The search index is not available
zibri
  • zibri
  • validation/functions/validate-boolean.function
  • validateBoolean

Function validateBoolean

  • validateBoolean(
        key: string,
        property: unknown,
        metadata:
            | StringPropertyMetadata
            | StringParamMetadata
            | NumberPropertyMetadata
            | NumberParamMetadata
            | BooleanPropertyMetadata
            | BooleanParamMetadata
            | DatePropertyMetadata
            | DateParamMetadata
            | ObjectPropertyMetadata
            | ObjectParamMetadata
            | ArrayPropertyMetadata
            | ArrayParamMetadata
            | UnknownPropertyMetadata
            | FilePropertyMetadata
            | ManyToOnePropertyMetadata<BaseEntity>
            | OneToManyPropertyMetadata<BaseEntity>
            | OneToOnePropertyMetadata<BaseEntity>
            | ManyToManyPropertyMetadata<BaseEntity>
            | BaseParamMetadata & OmitStrict<
                StringPropertyMetadata,
                "default"
                | "primary"
                | "excludeFromChangeSets",
            > & { name: Header }
            | BaseParamMetadata & OmitStrict<
                NumberPropertyMetadata,
                "default"
                | "primary"
                | "excludeFromChangeSets",
            > & { name: Header }
            | BaseParamMetadata & OmitStrict<
                BooleanPropertyMetadata,
                "default"
                | "excludeFromChangeSets",
            > & { name: Header }
            | BaseParamMetadata & OmitStrict<
                DatePropertyMetadata,
                "default"
                | "excludeFromChangeSets",
            > & { name: Header }
            | BaseParamMetadata & OmitStrict<
                ObjectPropertyMetadata,
                "excludeFromChangeSets",
            > & { name: Header }
            | BaseParamMetadata & OmitStrict<
                ArrayPropertyMetadata,
                "excludeFromChangeSets"
                | "items",
            > & { items: ArrayParamItemMetadata } & { name: Header },
        parentKey: undefined | string,
        entity: unknown,
    ): ValidationProblem[]

    Validates the given boolean property.

    Parameters

    • key: string

      The key of the property.

    • property: unknown

      The actual value.

    • metadata:
          | StringPropertyMetadata
          | StringParamMetadata
          | NumberPropertyMetadata
          | NumberParamMetadata
          | BooleanPropertyMetadata
          | BooleanParamMetadata
          | DatePropertyMetadata
          | DateParamMetadata
          | ObjectPropertyMetadata
          | ObjectParamMetadata
          | ArrayPropertyMetadata
          | ArrayParamMetadata
          | UnknownPropertyMetadata
          | FilePropertyMetadata
          | ManyToOnePropertyMetadata<BaseEntity>
          | OneToManyPropertyMetadata<BaseEntity>
          | OneToOnePropertyMetadata<BaseEntity>
          | ManyToManyPropertyMetadata<BaseEntity>
          | BaseParamMetadata & OmitStrict<
              StringPropertyMetadata,
              "default"
              | "primary"
              | "excludeFromChangeSets",
          > & { name: Header }
          | BaseParamMetadata & OmitStrict<
              NumberPropertyMetadata,
              "default"
              | "primary"
              | "excludeFromChangeSets",
          > & { name: Header }
          | BaseParamMetadata & OmitStrict<
              BooleanPropertyMetadata,
              "default"
              | "excludeFromChangeSets",
          > & { name: Header }
          | BaseParamMetadata & OmitStrict<
              DatePropertyMetadata,
              "default"
              | "excludeFromChangeSets",
          > & { name: Header }
          | BaseParamMetadata & OmitStrict<
              ObjectPropertyMetadata,
              "excludeFromChangeSets",
          > & { name: Header }
          | BaseParamMetadata & OmitStrict<
              ArrayPropertyMetadata,
              "excludeFromChangeSets"
              | "items",
          > & { items: ArrayParamItemMetadata } & { name: Header }

      The metadata of the property.

      • StringPropertyMetadata
      • StringParamMetadata
      • NumberPropertyMetadata
      • NumberParamMetadata
      • BooleanPropertyMetadata
      • BooleanParamMetadata
      • DatePropertyMetadata
      • DateParamMetadata
      • ObjectPropertyMetadata
      • ObjectParamMetadata
      • ArrayPropertyMetadata
      • ArrayParamMetadata
      • UnknownPropertyMetadata
      • FilePropertyMetadata
      • ManyToOnePropertyMetadata<BaseEntity>
      • OneToManyPropertyMetadata<BaseEntity>
      • OneToOnePropertyMetadata<BaseEntity>
      • ManyToManyPropertyMetadata<BaseEntity>
      • BaseParamMetadata & OmitStrict<
            StringPropertyMetadata,
            "default"
            | "primary"
            | "excludeFromChangeSets",
        > & { name: Header }
        • name: Header

          The name of the header.

      • BaseParamMetadata & OmitStrict<
            NumberPropertyMetadata,
            "default"
            | "primary"
            | "excludeFromChangeSets",
        > & { name: Header }
        • name: Header

          The name of the header.

      • BaseParamMetadata & OmitStrict<
            BooleanPropertyMetadata,
            "default"
            | "excludeFromChangeSets",
        > & { name: Header }
        • name: Header

          The name of the header.

      • BaseParamMetadata & OmitStrict<
            DatePropertyMetadata,
            "default"
            | "excludeFromChangeSets",
        > & { name: Header }
        • name: Header

          The name of the header.

      • BaseParamMetadata & OmitStrict<ObjectPropertyMetadata, "excludeFromChangeSets"> & {
            name: Header;
        }
        • name: Header

          The name of the header.

      • BaseParamMetadata & OmitStrict<
            ArrayPropertyMetadata,
            "excludeFromChangeSets"
            | "items",
        > & { items: ArrayParamItemMetadata } & { name: Header }
        • items: ArrayParamItemMetadata

          Metadata for the items inside this array parameter.

        • name: Header

          The name of the header.

    • parentKey: undefined | string

      The key of the parent, if it exists.

    • entity: unknown

      The entity that the value belongs to.

    Returns ValidationProblem[]

    All validation problems found.

    • Defined in src/validation/functions/validate-boolean.function.ts:14

Settings

Member Visibility
zibri
  • Loading...

Generated using TypeDoc