plugin-validate-boolean

A Flatfile plugin for boolean validation with multi-language support


plugin-autocast

A plugin for automatically casting values in Flatfile.

plugin-automap

A plugin to provide automapping imported files for headless workflows.

plugin-constraints

A plugin for extending blueprint with external constraints

plugin-convert-currency

A Flatfile plugin for currency conversion using Open Exchange Rates API

plugin-convert-json-schema

A plugin for converting JSON Schema to Flatfile Blueprint and configuring a...

plugin-convert-openapi-schema

A plugin for converting OpenAPI schema to Flatfile Blueprint.

plugin-convert-sql-ddl

A plugin for converting SQL DDL into Flatfile Blueprint.

plugin-convert-translate

A Flatfile Listener plugin for field translation using the Google Translate...

plugin-convert-what3words

A Flatfile plugin for converting What3Words addresses to standard addresses...

plugin-convert-yaml-schema

A plugin for converting YAML Schema definitions to Flatfile Blueprint.

plugin-dedupe

Dedupe records in a sheet via a sheet level custom action.

plugin-delimiter-extractor

A plugin for parsing .delimiter files in Flatfile.

plugin-dxp-configure

A plugin for using DXP class-based configurations.

plugin-enrich-geocode

A Flatfile plugin for geocoding addresses using the Google Maps Geocoding A...

plugin-enrich-gpx

A Flatfile plugin for parsing GPX files and extracting relevant data

plugin-enrich-sentiment

A Flatfile plugin for sentiment analysis of text fields in records

plugin-enrich-summarize

A Flatfile plugin for text summarization and key phrase extraction

plugin-export-delimited-zip

A Flatfile plugin for exporting Workbooks to delimited files and zipping th...

plugin-export-pivot-table

A Flatfile plugin for generating pivot tables from sheet data and saving as...

plugin-export-workbook

A plugin for exporting data in Flatfile to Workbooks.

plugin-extract-html-table

A Flatfile plugin for extracting table data from HTML files

plugin-extract-markdown

A plugin for parsing markdown files in Flatfile.

plugin-import-faker

A Flatfile plugin that generates example records using Faker

plugin-import-llm-records

A Flatfile plugin that generates example records using AI

plugin-import-rss

A Flatfile plugin for importing RSS feed data

plugin-job-handler

A plugin for handling Flatfile Jobs.

plugin-json-extractor

A plugin for parsing json files in Flatfile.

plugin-markdown-extractor

A plugin for parsing markdown files in Flatfile.

plugin-pdf-extractor

A plugin for parsing PDF files in Flatfile.

plugin-record-hook

A plugin for running custom logic on individual data records in Flatfile.

plugin-rollout

A plugin for automatically rolling out new changes to workbooks in flatfile...

plugin-space-configure

A plugin for configuring a Flatfile Space.

plugin-space-configure-from-template

A plugin for configuring a Flatfile Space from a Space Template.

plugin-stored-constraints

A plugin for running stored constraints

plugin-validate-boolean

A Flatfile plugin for boolean validation with multi-language support

plugin-validate-date

A Flatfile plugin for normalizing date formats

plugin-validate-email

A Flatfile Listener plugin for email validation

plugin-validate-isbn

A Flatfile Listener plugin for ISBN validation with configurable options. V...

plugin-validate-number

A Flatfile Listener plugin for number validation

plugin-validate-phone

A validator plugin for phone number formatting on individual data records i...

plugin-validate-string

A Flatfile plugin for string configuration and validation

plugin-view-mapped

A plugin for making the view post mapping show only mapped columns.

plugin-webhook-egress

A plugin for egressing data from a Flatfile Workbook to a webhook.

plugin-xlsx-extractor

A plugin for parsing xlsx files in Flatfile.

plugin-xml-extractor

A plugin for parsing .xml files in Flatfile.

plugin-zip-extractor

A plugin for unzipping zip files and uploading content back in Flatfile.

util-extractor

A library containing common utilities and helpers for extractors.

util-file-buffer

A utility for extracting data from any file and making it available as a bu...

util-response-rejection

This plugin handles response rejections returned from an external source.

Installation


Installnpm i @flatfile/plugin-validate-boolean
Source: View source
Package:@flatfile/plugin-validate-boolean 95 installs

@flatfile/plugin-validate-boolean

The @flatfile/plugin-validate-boolean plugin provides comprehensive boolean validation capabilities, offering flexible configuration options to handle various boolean representations across different languages and use cases.

Event Type: listener.on('commit:created')

Features

  • Supports both strict and truthy boolean validation
  • Multi-language support (English, Spanish, French, German)
  • Custom mapping for boolean values
  • Case-sensitive and case-insensitive options
  • Configurable null value handling
  • Option to convert non-boolean values
  • Custom error messages
  • Default value setting

Installation

To install the plugin, run the following command:

npm install @flatfile/plugin-validate-boolean

Example Usage

import { validateBoolean } from '@flatfile/plugin-validate-boolean';

listener.use(
  validateBoolean({
    fields: ['isActive', 'hasSubscription'],
    validationType: 'truthy',
    language: 'en',
    handleNull: 'false',
    convertNonBoolean: true
  }
));

Configuration

The BooleanValidator function accepts a configuration object with the following properties:

  • fields: An array of field names to validate
  • validationType: 'strict' or 'truthy'
  • customMapping: A custom mapping of string values to boolean
  • caseSensitive: Whether the validation should be case-sensitive
  • handleNull: How to handle null values ('error', 'false', 'true', or 'skip')
  • convertNonBoolean: Whether to convert non-boolean values to boolean
  • language: The language for predefined mappings ('en', 'es', 'fr', 'de')
  • customErrorMessages: Custom error messages for different scenarios
  • defaultValue: A default value to use for invalid inputs

Behavior

  1. Strict Validation: Only accepts 'true', 'false', true, or false as valid inputs.
  2. Truthy Validation: Accepts various representations of true/false, including language-specific terms.
  3. Null Handling: Configurable behavior for null or undefined values.
  4. Non-Boolean Conversion: Option to convert non-boolean values to boolean.
  5. Error Handling: Adds errors or info messages to the record for invalid inputs.
  6. Default Value: Option to set a default value for invalid inputs instead of raising an error.

The plugin can be used either as a RecordHook or as an external constraint, providing flexibility in integration with your Flatfile setup.