@brimbelle/license-plate
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    license-plate

    size logo last logo license logo version logo

    Simple package to validate or format world license plate

    Installation

    yarn add @brimbelle/license-plate
    # or npm install @brimbelle/license-plate

    Docs

    It's just the beginning of this lib, new locales are coming in next weeks.

    If you need a locale not present, post an issue to ask me or create a pull request with this locale added.

    At moment you can use FR, BE, and CH locales to validate and format your licenses plates.

    Find example HERE

    import LicensePlate from '@brimbelle/license-plate';

    LocaleCode

    type LocaleCode: 'FR' | 'BE' | 'CH';

    Set locale

    LicensePlate.setLocale(locale: LocaleCode); // Default is FR locale
    
    LicensePlate.setLocale('FR');

    Create license plate

    new LicensePlate(licensePlate: string, isCustom?: boolean);
    
    const licensePlate = new LicensePlate('AB123CD');

    Is valid license plate

    licensePlate.isValid(): boolean;

    Get formated license plate

    licensePlate.format(): string;

    License

    MIT License

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i @brimbelle/license-plate

    DownloadsWeekly Downloads

    2

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    28.7 kB

    Total Files

    49

    Last publish

    Collaborators

    • bubliotutyka