Nanotechnology Promises Much

    @netsells/laravel-api-parser

    2.0.0 • Public • Published

    npm version Build Status codecov Mutation testing badge

    Laravel API Parser

    Parse responses from Laravel API REST endpoints and extract meaningful errors related to your form fields

    Installation

    yarn add @netsells/laravel-api-parser
    

    Usage

    Note: it currently only works with axios response objects or any object with the same duck type.

    Import the ResponseParser class and instantiate it, passing in any custom options you would like to use

    import ResponseParser from '@netsells/laravel-api-parser';
    
    const responseParser = new ResponseParser();
    
    const response = await axios.post('/foo/bar', data);
    
    const errors = responseParser.getErrors(response);

    The getErrors returns an object containing the errors for the fields passed in. It may also return an object with a key of null representing a generic error for the entire response, rather than a single field.

    For a 422 error it may return:

    {
        email: 'You must enter a valid email'
    }

    For a 500 error it will return:

    {
        [null]: 'Something went wrong, sorry about that'
    }

    Customisation

    Config

    When instantiating the class, you can pass in an object with the following keys to override certain behaviour

    fallbackErrorMessage

    The error message used as the last resort, when no other errors could be parsed.

    new ResponseParser({
        fallbackErrorMessage: 'Woops, something went wrong! Please try again later',
    });

    Overrides

    You can override the ResponseParser class to change the functionality of it.

    When parsing errors, getErrors will look for a function based on the status of the response, e.g. getErrorsFor404 for a 404 status. If this doesn't exist, it will fallback to a function for the range of the status, in this case getErrorsFor4XX. Finally if that doesn't exist, it will return the fallback error message.

    So if you wanted to added custom errors for 404 responses, you could do this:

    import ResponseParser from '@netsells/laravel-api-parser';
    
    class MyResponseParser extends ResponseParser {
        getErrorsFor404() {
            return {
                [null]: 'Not found!',
            };
        }
    }
    
    const responseParser = new MyResponseParser();
    
    const response = await axios.get('/my-model/12'); // doesn't exist
    
    const errors = responseParser.getErrors(response); // { [null]: 'Not found!' }

    Contributing

    Pull requests are welcome! Ensure each PR includes a test case (which would fail without your changes) and that your build passes.

    Keywords

    none

    Install

    npm i @netsells/laravel-api-parser

    DownloadsWeekly Downloads

    108

    Version

    2.0.0

    License

    ISC

    Unpacked Size

    26 kB

    Total Files

    13

    Last publish

    Collaborators

    • rebeccaanderton
    • samturrell
    • martin91s
    • spamoom
    • jakub.gawron