Table of Contents

• 🌝 About
• 🕊 Features
• 🏁 Getting started
• 📖 Documentation
• 🎁 Contributing
• 💉 Running tests

🌝 About

spaceship is a utility library for JavaScript developers who make web services.

We want to contribute to productivity improvement by providing frequently used functions in the utility.

There are 10 useful utility functions in spaceship 1.0.

🕊 Features

✨Fetch

asyncState

Easily manage status that pending, success, failure at asynchronous request

detectBrowser

get browser info to use this info to handle many ituations

✨Browser

scriptLoader

When we want to dynamically import scripts.

isMobile

Detect the userAgent is Mobile

✨Data

getPadNumber

get formatted number string what you want.

normalizeKeyword

It can be used in user search keyword case and also it can be used to prevent typos to see accurate results

objToParam

Sometimes we make url with parameters from object data.

paramsToObj

when we develop web service, we frequently get data params and change to object

toTimeString

get TimeStamp from system time stamp

✨Etc

uniqueKey

generate Unique Key ( If you want some salt :)

🏁 Getting started

Installation

Using npm:

$ npm i @emplodies/spaceship

If you want to download by selecting the util

$ npm i @emplodies/spaceship.detect-browser

In a browser:

$ Sorry! Wait For a while. we'll prepare soon.

Hello World

import detectBrowser from "@emplodies/spaceship.detect-browser";
    
// If you use safari,
detectBrowser();
// => 'Safari'
    
// If you use Opera(or OPR)
detectBrowser();
// => 'Opera'

📖 Documentation

Our library Spaceship document site 

🎁 Contributing

Any kind of contribution is welcome. There are many ways to contribute to this project.

Question

Questions about the utilities provided by spaceship can be helpful to developers who are experiencing the same difficulty. If you have any questions about using the utility, please leave it as an issue.

We encourage all developers to share their content. :)

Information

If there is a bug in the existing utility or there is an error in the managed document, please report it as an issue.

It is very helpful in making better open source.

Add Utils

You can add a utility to spaceship.

When suggesting new features, please follow the procedure below.

1. New issue

Make new issue with enhancement template. And assign three maintainer.

2. Check Contributing Guide.

3. Fork the project.

4. Create a pr feature branch

$ git checkout -b pr/you-new-utils

4. Run the tests

5. Open a pull request.

💉 Running tests

To test utils

$ npm run install
$ npm run test

When you add your own util to this repo, check these rules ✅

1. You must add your util's test
2. Plz maintain all tests are passed 🙏

License

Spaceship is MIT licensed