@hygull/bibtex/src/BibTex.js

Get details about BibTeX (.bib) syntax, available ENTRY types and many more using Node APIs.

// https://nwalsh.com/tex/texhelp/bibtx-7.html
// http://bib-it.sourceforge.net/help/fieldsAndEntryTypes.php
//
// Programmed on: 14 Sep 2018, Fri
// Updated on   : 10 Oct 2018, Wed

const getEntryTypes = require('./getEntryTypes');
const getEntryTypeFields = require('./getEntryTypeFields');
const getEntryTypeDescription = require("./getEntryTypeDescription");
const getEntryTypeFieldsDescription = require("./getEntryTypeFieldsDescription");
const getFormFor = require("./getFormFor");
const getFields = require("./getFields");
const getBibTeXTemplateFor = require("./getBibTeXTemplateFor");
const getBibAsObject = require("./getBibAsObject");
const getBibCodeFromObject = require("./getBibCodeFromObject");
// const getBibAsObject2 = require("./getBibAsObject2");
// const fs = require('fs')

class BibTeX {
	// Definition of BibTeX's constructor
	constructor() {
		// this.entryTypes = fs.readFileSync('../json/entryTypes.json', 'utf-8')
		// this.entryTypeFields = fs.readFileSync('../json/entryTypeFields.json', 'utf-8')
		
		/*
			+----------------------+
			|   ADD METHODS HERE   |
			+----------------------+
		*/

		this.entryTypes = getEntryTypes();
		this.entryTypeFields = getEntryTypeFields();
		this.entryTypeDescription = getEntryTypeDescription();
		this.entryTypeFieldsDescription = getEntryTypeFieldsDescription();
		this.getFormFor = getFormFor;
		this.getFields = getFields;
		this.getBibTeXTemplateFor = getBibTeXTemplateFor;
		this.getBibAsObject = getBibAsObject;
		this.getBibCodeFromObject = getBibCodeFromObject;
		// this.getBibAsObject2 = getBibAsObject2;
	}

	// Getting all the entry types available in BibTeX
	getEntryTypes() {
		return this.entryTypes;
	}

	// Getting all the entry type fields (required + optional)
	getEntryTypeFields() {
		return this.entryTypeFields;
	}

	// Getting specific entry type fields based on their name
	getSpecificEntryTypeFields(entryTypeName) {
		// Converting entry type to lower case 
		entryTypeName = entryTypeName.toLowerCase();

		// If entry type is available in the list
		if(this.entryTypes.indexOf(entryTypeName) > -1) {
			return this.getEntryTypeFields()[entryTypeName];
		} else { // return null if it does not exist
			return null;
		}
	}

	// Getting Entry types description
	getEntryTypeDescription() {
		return this.entryTypeDescription;
	}

	// Getting Entry types, fileds, description
	getEntryTypeFieldsDescription() {
		return this.entryTypeFieldsDescription;
	}
}

module.exports = BibTeX;