GithubHelp home page GithubHelp logo

strapicleaner's Introduction

strapiCleaner

Used to remove the data and attributes property from strapi queries and responses.

To use import the library and use the .response(query) to clean a strapi response and .query(query) to clean a strapi query before sending the query.

The response function will return an object that is the same as the object you passed except without the data and attributes properties.

The query function will return a string that is the same as the query you passed except with data and attributes properties added. If you use the query function DO NOT include any data or attribute properties or the query will be invalid and strapi will return an error. The query passed should be exactly the same as a regular strapi query just without the data and attributes properties.

Installation

npm i strapi-cleaner

Usage

import strapiCleaner from "strapi-cleaner";

const query = `
    {
        team {
            name
            location {
                city
                country
            }
        }
    }
`;

const strapiQuery = strapi - cleaner.query(query);

/* returns :
{
        team {data {attributes {
            name
            location {data {attributes {
                city
                country
            }}}
        }}}
    }
*/

const reponse = {
    "data": [
        {
            "attributes": {
                "name": "kraken",
                "location": {
                    "data": {
                        "attributes": {
                            "city": "Seattle",
                            "country": "US"
                        }
                    }
                }
            }
        }
    ]
}
// returns { name: 'kraken', location: { city: 'Seattle', country: 'US' } }

Contributing

If you would like to see this package improved or if there are any bugs feel free to message me!

License

MIT

strapicleaner's People

Contributors

michaelthomas0721 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.