montagejs / collectionsjs.com Goto Github PK

The documentation does not distinguish between static and instance methods, making pages like this confusing:
http://www.collectionsjs.com/object

For example, there are two clone methods:

• the static method: Object.clone(object, depth, memo)
• and the instance method: someCollection.clone(depth, memo)

Only the latter is shown on the documentation for Object. However, only the former is actually implemented for Object. The latter is only available on collections.

Perhaps I'm mistaken? I'm just starting to read through the documentation to grok this library.

So that we can render the "Related" heading.

Or remove Related heading for the moment

$ npm run publish
'npm run publish' terminated by signal SIGSEGV (Address boundary error)

The stack of calls is:

• collectionsjs.com/scripts/publish.js

  Line 18 in 3e8726b

  gitFs.load("refs/remotes/origin/gh-pages")

• Through q-git to: https://github.com/montagejs/q-git/blob/9ca26fc1824718d6f697d29b29fe00fcb1059854/fs.js#L647
• and then https://github.com/montagejs/q-git/blob/9ca26fc1824718d6f697d29b29fe00fcb1059854/repository.js#L45
• and then into js-git https://github.com/creationix/js-git/blob/a2a42f32e325011f8828122707821ade28d41cec/mixins/fs-db.js#L134

Weird crash going on. This must be due to a change somewhere in js-git, but sadly I don't have time to debug now. Maybe @creationix can shed some light.

Related: #10

• names, why can there be multiple for the methods?
• collections and methods in the vice-versa file, are these two kept in sync manually?
• patterns, in has-key, is this left over?

I'm writing a TypeScript type definition for collections, which means I'm noticing a few flaws in the documentation.

• sortedSetLog method is in the documentation but not implemented. (http://www.collectionsjs.com/method/sorted-set-log)
• some has identical documentation to every (http://www.collectionsjs.com/method/some)
• every (and some?) claim to return true or false, but they actually return the last value returned by the callback

• Leave the search bar in the header?
• Write a better introduction
• Write better install instructions

_ should represent the last evaluated expression result.

Apparently, the domain expired yesterday and GANDI has set it to clientHold.

Gandi does not allow domains to be renewed by someone else, otherwise, I'd have gladly done so. Can someone look into this?

cc @marchant @kriskowal @hthetiot

No text is showing up.

Via montagejs/collections#79

We don’t really have an appropriate place to put this, but since it’s a property of all collections, maybe we can hack it into the template in a new "Properties" section.

[{ref, type, name, description}, ...] is what we need, I think

Related: #11

In page MultiMap, I read:

which creates a new bucketsfor a given key.

However, in collection/multi-map.md, the text is correct:

which creates a new bucket for a given key.

I guess there is transformer which automatically but mistakenly replaces the whitespace in "bucket for" with an "s".

there aren't any at the moment.

The documentation on www.collectionsjs.com is not visible due to the styles.css file..

• List
• Dequeue
• Map
• Set
• LruMap
• LruSet
• LfuMap
• LfuSet
• SortedMap
• SortedSet
• SortedArrayMap
• SortedArraySet
• Dict
• SortedArray
• MultiMap
• Heap
• WeakMap
• Iterator

I've omitted FastMap, FastSet, Object, and Array since they won't provide much value.

Library can be extended for implementing BINARY SEARCH TREE and SEGMENTED TREE.
Can I contribute for this.

Add a github icon link to the header of the page linking back to https://github.com/montagejs/collections

The last 2 methods are the same refs. We should only show last one (with the longest method signature).

To be able to quickly scan through and see the differences.

The title on http://www.collectionsjs.com/method/find-greatest-less-than is findLGreatestLessThan(value)

If necessary, since it can grow below the fold.

Under Usage we could add the require needed, e.g. var Map = require("collections/map");

This might involve change the Object and Array urls to shim-object and shim-array if we want to reuse the page ref as the module name.

You can utilize https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme

Firefox:

• Map
• LruMap
• Dict (needs improvement to avoid RangeError)
• Set
• Iterator

It would be nice to be able to use the wonderful classes here, but not to have surprising side effects on all other modules and core code.

Is there a way to use this module without altering Array or other monkey-patch type alterations of core libraries ?

A small/dimmed link somewhere, maybe in a footer, so people can report issues on this repo and perhaps even PRs.