Wondering what’s next for npm?Check out our public roadmap! »

    laravel-form-errors

    1.2.0 • Public • Published

    FormErrors License NPM

    Travis Build Codacy grade Code Coverage Latest Release Downloads GitHub issues

    By ARCANEDEV©

    An error helper inspired from Laravel's Illuminate\Support\MessageBag that allows you to handle the validation messages.

    Feel free to check out the releases, license, and contribution guidelines.

    Installation

    Coming soon...

    Usage

    Coming soon...

    API

    /**
     * Get the raw messages.
     *
     * @return {any} 
     */
    getMessages(): any;
    /**
     * Set the raw messages.
     *
     * @param  {any}  messages 
     */
    setMessages(messages: any): void;
    /**
     * Get the default message format.
     *
     * @return {string} 
     */
    getFormat(): string;
    /**
     * Set the default message format.
     *
     * @param  {string}  format 
     */
    setFormat(format:string): void;
    /**
     * Add a message to the collection.
     *
     * @param  {string}  key 
     * @param  {string}  message 
     *
     * @return void
     */
    add(key: string, message: string): void;
    /**
     * Merge a new array of messages into the collection.
     *
     * @param  {any}  messages 
     *
     * @return {void} 
     */
    merge(messages: any): void;
    /**
     * Get the keys present in the message bag.
     *
     * @return {string[]} 
     */
    keys(): string[];
    /**
     * Determine if messages exist for all of the given keys.
     *
     * @param  {string|string[]}  key 
     *
     * @return {boolean} 
     */
    has(key?: string|string[]): boolean;
    /**
     * Determine if messages exist for any of the given keys.
     *
     * @param  {string[]}  keys 
     *
     * @return {boolean} 
     */
    hasAny(keys: string[]): boolean;
    /**
     * Get the first message from the bag for a given key.
     *
     * @param  {string}       key 
     * @param  {string|null}  format 
     *
     * @return {string} 
     */
    first(key: string, format?: string): string;
    /**
     * Get all of the messages from the bag for a given key.
     *
     * @param  {string}  key 
     * @param  {string}  format 
     *
     * @return {any} 
     */
    get(key: string, format?: string): any[];
    /**
     * Get all of the messages for every key in the bag.
     *
     * @param  {string|null}  format 
     *
     * @return {any} 
     */
    all(format?: string): any;
    /**
     * Reset all the validation messages.
     */
    reset(): void;
    /**
     * Determine if the message bag has any messages.
     *
     * @return bool
     */
    any(): boolean;
    /**
     * Determine if the message bag has any messages.
     *
     * @return {bool} 
     */
    isEmpty(): boolean;
    /**
     * Get the number of messages.
     *
     * @return {number} 
     */
    count(): number;

    Contribution

    Any ideas are welcome. Feel free to submit any issues or pull requests, please check the contribution guidelines.

    Security

    If you discover any security related issues, please email arcanedev.maroc@gmail.com instead of using the issue tracker.

    Credits

    Keywords

    none

    Install

    npm i laravel-form-errors

    DownloadsWeekly Downloads

    10

    Version

    1.2.0

    License

    MIT

    Last publish

    Collaborators

    • avatar