Skip to content

senadores-chile/senadores-base

Repository files navigation

senadores-base npm version Build Status js-standard-style

Información basica y estatica de los senadores actuales de Chile

Instalación

npm install --save senadores-base

Uso

var senadoresBase = require('senadores-base')

senadoresBase({ nombre: 'Allamand' })
/*
    [ { id: 905,
    nombre: 'Allamand Zavala, Andrés',
    rut: '5002921-2',
    region: 'Región Metropolitana ',
    circunscripcion: 7,
    telefono: '(56-32) 2504701',
    mail: '[email protected]',
    partido: 'R.N.' } ]
*/

API

senadoresBase([query])

Función que retorna siempre un arreglo con los senadores encontrados luego de aplicar los filtros ingresados en la variable query. El parametro query es opcional y sirve para filtrar el arreglo de senadores:

  • si no se ingresa, se retornan todos los senadores
  • si se ingresa un string, se busca por nombre
  • si se ingresa un numero, se busca por rut
  • si se ingresa un objeto, se busca por cada uno de los campos ingresados
  • si se ingresa un arreglo, se espera que el arreglo tenga valores numericos o strings, y que correspondan a ruts o nombres de senadores.

(para más información, revisa los tests).

filter(array [, query])

También se expone una función filter que sirve para filtrar arreglos de senadores, util para los otros modulos de senadores.

  • array: El arreglo que contiene los senadores. Puede ser un arreglo de objetos que contienen las propiedades de los senadores (como el devuelto por este modulo), o un arreglo de objetos que tienen dentro de sus primeras propiedades algún campo llamado 'senador'.
  • query: El mismo query que acepta este modulo para filtrar. *

* Notese que el filtro no acepta ingresar un arreglo como filtro, es decir, los unicos queries que no funcionarán igual son los de este estilo filter(senadores, ['Allende', 'Allamand'])

Ejemplo

const { filter } = require('senadores-base/utils')

const arr1 = senadores() // este modulo
const arr2 = [{
    senador: {
      // datos de un senador
    },
    // alguna otra propiedad
  }]

// usos
assert.deepEqual(filter(arr1, 'Allamand'), filter(arr2, 'Allamand').senador) // true

Otros enlaces

Licencia

MIT © Yerko Palma.

About

💩 Información basica y estatica de los senadores actuales de Chile

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published