阅读不完整的API文档 - 如果没有列出,您如何知道所有[选项]是什么?

时间:2013-05-13 03:34:32

标签: node.js api mongoose

当你没有列出时,你如何找到所有可用的[options]

对于mongoose nodejshttp://mongoosejs.com/docs/api.html#schema_Schema-index

示例有帮助,但通常不完整。如何追踪您可以作为第二个参数传递的options的完整范围?

读取

Schema#index(fields, [options])

Defines an index (most likely compound) for this schema.

show code
Parameters:

fields <Object>
[options] <Object>
Example

schema.index({ first: 1, last: -1 }, { unique: true })

在某些地方,所有的选项都很详细,这很精彩。 例如:

http://mongoosejs.com/docs/api.html#connection_Connection-openSet

感谢。

另外,我发现了这个可爱的问题/答案。

How to read API documentation for newbs?

1 个答案:

答案 0 :(得分:3)

显而易见的答案是阅读源代码,但我经常发现阅读测试通常更容易。测试通常是开发人员关心的一些代码。

在Schema Index的情况下,测试提到了几个选项:https://github.com/LearnBoost/mongoose/blob/master/test/schema.test.js#L1028

然而,在进一步挖掘之后,许多选项都与特定模式类型相关联:https://github.com/LearnBoost/mongoose/blob/master/lib/schematype.js#L96