@niitsolutions/kru v1.1.2

KRU - KoiraRekisteri Utility

Shared code for koirarekisteri.fi services. The rest of this readme is in Finnish.

Koirarekisterin palveluiden jaetut datat, vaihtoehdot, skeemat ja apukoodit

Asennus

Selain (react / webpack):

npm i "@niitsolutions/kru"

Palvelin (node):

npm i "@niitsolutions/kru" dotenv flat mongoose nodemailer mailgen path

KRU Versiot

"@niitsolutions/kru" on selainystävällinen, ei vaadi node palvelimen paketteja.

"@niitsolutions/kru/server" sisältää kru:n sekä mongoose skeemat ja sähköposti työkalun.

"@niitsolutions/kru/fetcher" on Fetch adapteri jota voi käyttää vain selaimessa! Palvelimet yhdistävät tietokantaan mongoosen ja skeemojen avulla.

Käyttö

KRU:n eri osien käyttöesimerkkejä.

Data

Datamoduulit sisältävät Koirarekisterin formeissa käytetyt vaihtoehdot. Myös hallintapaneeli käyttää kru:n datamoduuleita.

Kaikki datamoduulit toimivat samalla tavalla. Datamoduulit ovat Objekti Arraytä. Objektit sisältävät value ja label kentät. Arrayhin on myös lisätty .options ja .labels String Arrayt jotka sisältävät kaikki valuet ja labelit samassa järjestyksessä.

Lista KRUsta löytyvistä datoista:

• karvat
  • Koiran karvatyyppi vaihtoehdot
• ominaisuudet
  • Koiran karvaominaisuus vaihtoehdot
• värit
  • Koiran värivaihtoehdot
• kuviot
  • Koiran värikuvioiden vaihtoehdot
• käyttötarkoitukset
  • Koiran käyttötarkoituksen vaihtoehdot
• alkuperät
  • Koiran sukutaulun alkuperän vaihtoehdot
• rekisteriLuokat
  • Koiran rekisteriluokan vaihtoehdot
• rekisteriTavat
  • Koiran rekisteröintitavan vaihtoehdot
• kunnat
  • Lista Suomen kunnista
• maat
  • Lista maailman valtioista
• serverit
  • Lista Koirarekisterin palvelimien URL osoitteista

Esimerkkeinä datamoduuleista rekisteriLuokat ja maat:

import { rekisteriLuokat, maat } from "@niitsolutions/kru";

console.log(rekisteriLuokat); // [{ value: "L", label: "Lemmikkiluokka" }, { value: "J", label: "Jalostusluokka" }];
console.log(rekisteriLuokat.options); // ["L", "J"];
console.log(rekisteriLuokat.labels); // ["Lemmikkiluokka", "Jalostusluokka"];

console.log(maat); // [{ value: "Suomi", label: "Suomi" }, { value: "Ruotsi", label: "Ruotsi" } ...]
console.log(maat.options); // ["Suomi", "Ruotsi", "Viro", ...]
console.log(maat.labels); // ["Suomi", "Ruotsi", "Viro", ...]

Huom:

• .options array on nimeltään options koska .values on javascriptissä varattu ominaisuus

Apurit

Apurit eli helpers ovat funktioita jotka suorittavat yksinkertaisia operaatioita joita tarvitaan useassa paikassa. KRUn apurit ovat iso ja vuodet.

iso(s) palauttaa stringin isolla alkukirjaimella. Käytetään palvelimilla mm. mallien nimien oikeinkirjoituksen varmistamiseen.

const kru = require("@niitsolutions/kru");
const teksti = "kOIrA";
const Model = kru.iso(teksti);
console.log(model); // "Koira"

vuodet(taakse, eteen) luo arrayn vuosilukuja nykyisestä vuodesta taakse ja/tai eteenpäin. Vain taakse on pakollinen argumentti, eteen on itsestään 0 jos sitä ei anneta.

import { vuodet } from "@niitsolutions/kru";
const vuosiValinnat = vuodet(5, 2);
console.log(vuosiValinnat); // [2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024]

Yleiset huomiot

• import * from '*'; ei toimi node palvelimella
• const * = require('*'); toimii node palvelimella ja selaimessa webpackin avulla

KRU käyttää require() sisäisesti

TO-DO

• Mailer dokumentaatio
• Schemas dokumentaatio