Cerceislib NPM

Cerceis's Book Of Magic 📚

The place you might find the spell you want.

This library provides various functions that you might find it useful during development

#I am reamking the documentation, some of docs below still works but not all

セルセイスの魔導書 📚

欲しかった呪文が見つかるかもしれません。

INSTALLATION

npm install cerceislib@latest --save

使い方・How to use

普通のHTML・Normal HTML script tag:

<script src="<pathTo>/cerceisLibrary.js"></script>
<script>
    cerceisLib.invokeMagic()
</script>

Vue/React/Angular/etc:

import cerceisLib from "cerceislib";
cerceisLib.invokeMagic()

NodeJS

const cerceisLib = require('cerceislib')
cerceisLib.invokeMagic()

List of functions

#+Number to search (Windows:ctrl+F, Mac:cmd+F).

String related
- @1 Strip all html tags from String
- @6 Check String if its Alphanumeric (No symbols)
- @7 Get substring between 2 characters or string, if multiple result is available, choosing is possible.
Array related
- @2 Shuffle all element in an array
- @4 Remove duplicated elements and return array consist of only of the non-duplicated elements
- @8 Extract specified property value from object or arrays of object
- @9 Return array contains only unique field
- @10 Get random Element from result (Can specify number of returns)
- @11 Sum all array element (Works on String element too)
Generate
- @3 Generate ObjectID from timestamp
- @5 Generate Random String (Able to define format)
Object related
- @8 Extract specified property value from object or arrays of object

呪文一覧

#+番号を(Windows:ctrl+F, Mac:cmd+F)で探す。

String関連
- @1 StringのHTMLのタッグを全部外す
- @6 StringがA-z,0-9だけ含んでいるかどうか
- @7 Stringの中で指定した二つの点の間の内容だけ抽出
Array
- @2 配列の要素を全部ランダムに並び替える
- @4 二つの配列の要素をそれぞれ比べて、重複しなかった要素だけ見つける
- @8 Objectの配列・Objectから特定のプロパティを抽出
- @9 配列の中のユニークな値を抽出
- @10 配列からランダムな要素を抽出（個数指定可）
- @11 配列要素の和を求める（Stringの要素も可）
生成関連
- @3 MongoDB用のObjectIdを生成する
- @5 ランダムなIDを生成する（長さ・フォマット指定できる）
Object関連
- @8 Objectの配列・Objectから特定のプロパティを抽出

cerceisLib :

#11 📘sumAllArrayElement(arr) v.0.1.2
- Sum all array element (Works on String element too)
- arr(Array)
#10 📘getRandomFromArray(arr,noOfResult) v.0.1.1
- Get random Element from result
- arr(Array)
- noOfResult(Number)
#9 📘returnNonDuplicated(inputArr) v.0.1.0
- Return array contains only unique field
- inputArr(Array)
#8 📘extractField(inputObjectOrArray,targetFieldName) v.0.1.1
- Extract specified property value from object or arrays of object
- inputObjectOrArray(Object)/(Array)
- targetFieldName(String)/(Arary)
#7 📘getContentBetween2Char(inputString, strA, strB, indexOfResult) v.0.0.4
- Get substring between 2 characters or string, if multiple result is available, choosing is possible.
- inputString(String)
- strA(String) : Starting char or string
- strB(String) : Ending char or string
- indexOfResult(Number)*Optional' : Define which result to return (Start from 1)
#6 📘checkIfAlphanumeric(inputText) v0.0.3
- Check String if its Alphanumeric (No symbols)
- inputText(String)
- returns Boolean
#5 📘generateRandom(type,length,format) v.0.0.3
- Generate Random String (Able to define format
- type(String)
  - "Number" : Generate random Number
  - "String" : Generate random Alphabet
  - "Number+String" : Generate random Number+Alphabet
  - "Format" : Generate random type defined by user (see *format)
- length(Number)
  - Define the length of the result
  - Ignored in type "Format"
- format(String)
  - Define Generated format
  - N = Number, S = String
  - Example
```
console.log( generateRandom("Format", 0, NN-SS:NNNN) )
:=> "52-Dv:7895"
```
#4 📘compareAndReturnNonDuplicated(arr1, arr2, returnIndex) v0.1.3
- Remove duplicated elements and return array consist of only of the non-duplicated elements
- arr1(Array),arr2(Array)
- returnIndex(Boolean)
- returns Array
#3 📘generateMongoObjectId() v0.0.1
- Generate ObjectID from timestamp
- returns ObjectId
#2 📘shuffleArray(array) v0.0.1
- Shuffle all element in an array
- array(Array)
- returns Array
#1 📘stripHTML(stringHtml) v0.0.1
- Strip all html tags from String
- stringHtml(String)
- returns String
#0 📘invokeMagic()
- To test its working
- ちゃんと動いていることを確認する