Installation

To install this module through npm, simply use the following command:

$ npm install --save fibtastic

and then require it in your project like so:

// Node
const fibtastic = require('fibtastic');

// Webpack
import * as fibtastic from 'fibtastic';

// Browser
import * as fibtastic from '/path/to/fibtastic.js';

Basic Example

Using fibtastic is short and simple. Calculating the fibonacci sequence from the 10th to the 15th number is shown below:

const fibonacci = require("fibtastic");

const sequence = fibonacci.sequence(10, 15);

console.log(sequence);
// => [55, 89, 144, 233, 377, 610]

API

There are currently three methods that make up fibtastic with the above sequence included.

sequence

Sequence takes an object with an optional start time and a required end time and returns the fibonacci sequence from the specified start point to the end point with the start and end points included.

| Type | Option | Description | Default | | ------ | ------ | ----------- | ------- | | number | start | Location in the fibonacci sequence to start | 0 | number | end | Location in the fibonacci sequence to stop | none (required)

Example:

const sequence = fibonacci.sequence(10, 15);

console.log(sequence);
// => [55, 89, 144, 233, 377, 610]
// => [55, 89, 144, 233, 377, 610]

value

Value is used to find the fibonacci number at a specific point in the sequence.

| Type | Option | Description | Default | | ------ | --------- | ----------- | ------- | | number | location | The location in the fibonacci sequence to retrieve the value from | none (required)

Example:

const value = fibonacci.value(20);

console.log(value); 
// => 6765

isValue

IsValue takes a value and check to see if that value is a part of the fibonacci sequence. If it is, it returns the location in the sequence where the value is and if it is not part of the fibonacci sequence it returns false.

Note: If the value is less than 2 but greater than 0, isValue will just return true because the value 1 occurs in two locations in the fibonacci sequence and it is not possible to deduce which location is desired.

| Type | Option | Description | Default | | ------ | ------ | ----------- | ------- | | number | value | The value to use to search the fibonacci sequence and find the location | none (required)

Examples:

const isValue = fibonacci.isValue(6765);

console.log(isValue); 
// => 20

const isValue = fibonacci.isValue(6770);

console.log(isvalue); 
// => false

const isValue = fibonacci.isValue(1);

console.log(isValue); 
// => true

Running Tests

To run the tests, use:

npm run test

License

MIT