hg-pyun / iterize

Use JavaScript Iterator, Easily

iterize's Issues

Add mssing guide to README.md

1. Change Word
   generator -> Iterable protocol

2. Add Import Guide

import * as iterize from 'iterize';
or
import { range } from 'iterize';

3. Fixed indent

// As - Is
import { range } from 'iterize';
// To - Be
import {range} from 'iterize'; 

4. Remove iterize word in interface

// As - Is
iterize.range
// To - Be
range

Define Argument Types

Define Argument Types.
Reference: https://github.com/line/line-bot-sdk-nodejs/blob/master/lib/types.ts

Discuss 1.4.0 feature

Reformat Code

When the prettier setting is done, reformatting the all codes.

Test code Scaffording

• Range
• Cycle
• Take
• Repeat
• Replicate

take or takewhile?

Is it necessary dividing take and takewhile ?

Discuss 1.1.0 feature

Expected Feature List

• Exception handling when using infinite type on cycle, repeat, replicate method.
• Support function type.
• Refactoring Error Models.
• Refactoring Test Cases.
• Discuss default parameter on range.

range(1, 10) // default step 1,
range(10, 1) // default step -1

Develop take abstract function API

take(x => x < 5, [1,4,6,4,1]) --> 1 4

Make Change Log for versions

Make change log for versions on markdown document.

Improve range API

Summary

Improve range API.

Feature

• one arguments

range(5) // [0, 1, 2, 3, 4]

• two arguments

range(1, 10) // default step 1,
range(10, 1) // default step -1

TODO

• one arguments
• two arguments

cord convention

Set up Prettier

• install
• git prehook

write spread syntax test code

A test code is required for the spread operator.
Here are some example.

example

[...range(1, 10, 1)]; // [1, 2, 3 ... 9]
[...range(1, 10, x => x + 1)]; // [1, 2, 3 ... 9]
[...range(2, 64, x => x * x)]; // [2, 4, 16]

const rangeIterator = range(1, 5, 1);
[...replicate(2, rangeIterator)]; // [1, 2, 3, 4, 1, 2, 3, 4]

Support string type on cycle

cycle('ABCD') --> A B C D A B C D ...

Add Issue, PR templates

Add Issue and Pull Request Templates.
Here are some reference

• https://blog.github.com/2016-02-17-issue-and-pull-request-templates/
• https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/

Combine repeat and replicate api

Merge repeat and replicate api. Because of duplicated method.

repeat(item, count);

Document Page

Setup document guide page.
i think it used to github.io.

@ts-ignore change to <any> type casting on test cases

@ts-ignore change to <any> type casting on test cases

Exception handling when using infinite type

Summary

cycle, repeat, replicate check the iterator param that RepeatIterator.
It is not necessary to include repetition in a function that is already repetitive.

Feature

• Type checking the iterator parameter is RepeatIterator.

TODO

• Make test case
• Type checking cycle
• Type checking repeat
• Type checking replicate

Support log messages on dev environment.

Many libraries support logging message for easy debugging. Normally, using process.env.NODE_ENV, switching between dev and production environment. Let's talking about this.

Define Combination API

#1 Development is done.
Let's discussion combination APIs.

APIs

• Cycle

let range = iterize.range(1, 5, 1);
cycle(range);
// 1 2 3 4 1 2 3 4 1 2 3 4 ...

• Replicate
  Add generator type parameter

const range = iterize.range(1, 5, 1);
iterlize.replicate(2, range);
1 2 3 4 1 2 3 4 

Performance Benchmarks

Iterize needs to benchmarks for testing native or another library.

Discuss 1.2.0 feature

Purpose

• Add higher-API functions
• Refactoring
• Fixed Bugs

Ideas

• Support string type on cycle

cycle('ABCD') --> A B C D A B C D ...

• combine repeat and replicate api

repeat(item, count);

• takewhile

takewhile(x => x < 5, [1,4,6,4,1]) --> 1 4

• accumulate

accumulate([1,2,3,4,5]) --> 1 3 6 10 15
accumulate([1,2,3,4,5], operator.mul) --> 1 2 6 24 120

Discuss

• How about refer python3 itertools?

Refactoring Test Cases

Summary

Current test cases are written inefficiently.

Feature

• Reduce duplication

{ value: 0, done: false }

• Using a repeated sentence

// refactor using 'for' syntax
it('number type', () => {                                        
    const iter = repeat(0);                                      
    expect(iter.next()).to.deep.equal({ value: 0, done: false });
    expect(iter.next()).to.deep.equal({ value: 0, done: false });
    expect(iter.next()).to.deep.equal({ value: 0, done: false });
    expect(iter.next()).to.deep.equal({ value: 0, done: false });
    expect(iter.next()).to.deep.equal({ value: 0, done: false });
});                                                              

TODO

• Make reduce util
• Change for syntax

Discuss 1.3.0 feature

Discuss 1.3.0 features.

• Refactoring
• Performance Optimization

Happy New Year!

Happy New Year 🎉

Release 1.1.0

Release 1.1.0

Refactor README.md

• Rewrite API document
• Change download shield.io to absolute value

Support browser version

Currently, it is built in a structure that can only be used in nodejs using the babel-runtime. For immediate use by browser via CDN, source code bundling is required. Now we're thinking about using webpack to create a version that we build separately.

Purchase iterize.io domain

Purchase iterize.io domain

write for-of test code

Need to write down for-of test code.

Add for-of syntax example

How about add for-of syntax example on README.md or cookbook ?

Improve lazy evaluation

The parts that receive the Iterator in the replicate and cycle APIs are not exactly satisfied with the lazy evaluation. This is because an array is built internally using the spread operator.

cycle.ts

if (isGenerator) {
     cycleItem = [...item];
}

replicate.ts

if (isGenerator(item)) {
      let spreadItem = [...(item as IterableIterator<any>)];
      let iterItem: any[] = [];

      for (let i = 0; i < count; i++) {
          iterItem = iterItem.concat(spreadItem);
      }
...

Improvements are needed to evaluate dynamically using iterator.

Support Universal Module Define

Support UMD by https://github.com/umdjs/umd

Improve Checking Iterable

How about this ?

if(someObject(Symbol.iterator]))

Update Contributing Guide

Update Contributing Guide

Add CI Tools

Discuss bring in CI Tools

Support Function Type

Summary

Support Function Type.

Feature

• cycle

cycle([fn1, fn2, fn3])

• repeat

repeat(fn);

• replicate

replicate(3, fn);

TODO

• Make test case
• Type checking
• Implement fn argument

Refactoring Term

• taker -> predicate
• item -> seq

API architecture

Description about API architecture.

APIs

• Range

// API
range(start: number, end: number, step: number | Function): Iterator

// example
iterize.range(1, 10, 1);
iterize.range(1, 10, x => x+1);
1 2 3 ... 9

• Cycle

// API
cycle(arr: Array<any>): Iterator

// example
iterize.cycle([1, 2, 3]);
1 2 3 1 2 3 1 2 3 1 2 ...

• Take

// API
iterize.take(count: number, iter: Iterator): Iterator

// example
const cycle = lterize.cycle([1, 2, 3]);
iterize.take(5, cycle);
[1, 2, 3, 1, 2]

• Repeat

// API
iterize.repeat(item: number | string): Iterator

// example
iterize.repeat(5)
5 5 5 5 5 5 5 5 ...

• Replicate

// API
iterize.replicate(count: number, item: number | string): Iterator

// example
iterize.replicate(3, 10)
10 10 10

Reference

• https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/function*
• https://github.com/medikoo/es6-iterator
• https://gist.github.com/qodot/ecf8d90ce291196817f8cf6117036997
• https://www.npmjs.com/package/iter-tools

Write cookbook

Many library have cookbook that explain how to use it. It seems that it could make many combinations.
How about write cookbook? I attach reference ramda.

Support Promise Argument

How about add promise argument ?

take(a => a <2, [Promise.resolve(1), Promise.resolve(2)]);

Improve Prettier Rules

Improve Prettier Rules

Write down API Document

Write down API Document. For now, write down the definition of api spec on README.md.
After Let's make a later API-related document.

Change License

Change License Apache 2.0 to MIT

Define *.d.ts

Define *.d.ts, TBD

Add PR Templates

Add PR Templates.

Refactoring Error Model

Summary

There is currently overlap in the error model. It optimizes this.

Feature

Redesign Error Model.

• Input Type Error
• Argument Error
• Behavior Error

TODO

• Redesign error model.
• Fixed test cases.

Setup partial test environment

Currently, Mocha is testing all of the test cases. We need to create a partially testable environment.

Planning 1.5.0

• takewhile #78 #79
• refactoring @ts-ignore #75

Logo Design

TBD