spa_codegenerator/readme.md

NPM:

## Instalación

NPM:

> `npm install spa_codegenerator --save`

## Uso:
```js
const scm = require('spa_codegenerator');
const manager = new scm.createBASE('MyCodes', {
    codesLength: 6, // Longitud del código.
    generateInUTF8: true, // Intercambiar entre string o números.
    insertSomething: { // Insertar string cada x longitud.
        string: ':', // El string que deseas insertar.
        eachString: 2, // Cada cuantos caracteres deseas insertar el string.
    },
    deepSave: true // Guardar códigos en la base.
});

manager.generateCode(2).then(async x => {
    console.log(x);
});
```

## Versión
**__0.0.3-prototype__**:
> Creado el 30/1/2021 by ! Ethan#6737

## Docs

> `Nota: deepSave es una propiedad booleana. Si permanece en "false", solo la función "generateCode()" funcionará. Las demás retornarán undefined.`

**generateCode(amount, codeEndAtString)**
Genera códigos basados en la configuración inicial, se puede añadir un string al final de cada generación.
Amount: Opcional, por defecto: 1.
CodeEndAtString: Opcional, por defecto: null.
```js
manager.generateCode(100, 'mycode').then(x => console.log(x));
```

**findCode(code)**
Con la propiedad deepSave en "true", se buscará el código solicitado y en caso de encontrarlo devolverá el código y su posición en el JSON.
Code: Requerido.
```js
manager.findCode('anyCode').then(x => console.log(x));
```

**findCodeAndUpdate(code, newCode)**
Usa la función "findCode" para obtener el código y luego sustituirlo. Su posición en el JSON cambiará.
Code: Requerido.
NewCode: Requerido.
```js
manager.findCodeAndUpdate('anyCode', 'newCodeToMyself').then(x => console.log(x));
```

**findCodeAndUpdate(code)**
Usa la función "findCode" para obtener el código y borrarlo del JSON.
Code: Requerido.
```js
manager.findCodeAndUpdate('newCodeToMyself').then(x => console.log(x));
```

**getAllCodes()**
Obtiene todos los códigos existentes en el array del JSON. Si la propiedad "deepSave" es "false", devolverá un array vacío.
```js
manager.getAllCodes().then(x => console.log(x));
```

## Información

Soporte del npm en nuestro discord:

- [Discord](https://discord.gg/RuBvM5r9eM)
- [Bot oficial](https://discord.com/oauth2/authorize?client_id=779660400081764393&scope=bot&permissions=8)