npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@flatfile/plugin-validate-phone

v0.3.0

Published

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

Downloads

147

Readme

@flatfile/plugin-validate-phone

The @flatfile/plugin-validate-phone plugin offers a convenient way to validate phone numbers. By setting up an event listener for the commit:created event, this plugin seamlessly integrates with the data processing flow. This plugins supports phone number formatting for multiple countries (US, UK, India, Germany, France, and Brazil).

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

Parameters

config.sheetSlug - string - default: ** - (optional)

The sheetSlug parameter is the slug of the sheet you want to listen to. By default it listens to commits in all sheets.

config.phoneField - string

The phoneField parameter is the phone field's name.

config.countryField - string

The countryField parameter is the country field's name.

config.autoConvert - boolean - default: true - (optional)

The autoConvert parameter allows you to specify whether the field's format will automatically be converted.

config.concurrency - number - default: 10 - (optional)

The concurrency parameter allows you to specify the number of records to process concurrently.

config.debug - boolean - default: false - (optional)

The debug parameter allows you to turn on debug logging.

config.format - NumberFormat - default: 'NATIONAL' - (optional)

The format parameter specifies the desired output format for the phone number. Options include 'NATIONAL', 'INTERNATIONAL', 'E164', 'RFC3966', and 'SIGNIFICANT'.

config.formatOptions - FormatNumberOptions - (optional)

The formatOptions parameter allows you to pass additional formatting options as defined by the libphonenumber-js library.

Usage

npm install @flatfile/plugin-validate-phone

Import

import validatePhone from '@flatfile/plugin-validate-phone';

Example Usage

This example sets up a record hook using listener.use to validate and format phone numbers in the "my-sheet" sheet which contains a phone number field called phone_number and a country field called country_code.

import { FlatfileListener } from '@flatfile/listener';
import validatePhone from '@flatfile/plugin-validate-phone';

export default function (listener: FlatfileListener) {
  listener.use(validatePhone({
    sheetSlug: 'my-sheet',
    phoneField: 'phone_number',
    countryField: 'country_code',
    autoConvert: true,
    format: 'INTERNATIONAL',
    formatOptions: { formatExtension: 'national' }
  }));

  // ... rest of your Flatfile listener
}