01-About Documentation

本文介绍了Node.js官方文档的三种类型:参考文档提供了详细的API版本信息及使用细节;入门资料帮助初学者理解Node.js的基本概念;教程则针对具体应用场景提供深入指导。所有文档专注于Node.js内置模块。

s

About Documentation

  我们认为文档对于用户很重要,但是不同的用户对文档的要求也不一样。所以,在nodejs.org上,你会看到三种类型的文档:

1、reference documentation

2、getting started documentation

3、tutorials


  API reference documentation主要是提供方法或pattern详细的版本信息,通过这个文档你可以明确方法的参数列表和返回值,以及相关的错误信息(异常?或是返回值的error code?不清楚,暂且这样认为吧)。并且通过这个文档你也可以识别不同版本的node.js该使用过哪个方法。(可能最新的方法在老的版本中不支持,或者有些方法在新的版本中已经废弃)


  Getting Started materials 是为了让你轻松入门、理解Node中的一些概念。通常是一些简单的代码片断,以帮助你理解Node中设计模式,同样在社区中的其它模块中你也会看到类似的模式。


  Tutorials是稍高级点的主题、文档,旨在指导用户详细的使用Node的用例。其主要强调Node的不同使用方法,但不讨论它与社区中第三方模块的异同。


    所有的文档只涉及Node内建的模块,Node对争谁更牛逼没兴趣,我们只客观地讨论我们的API。


s



s

Build file '/Users/ts-xin.e.yu/IdeaProjects/opp-bulk-auto-recovery-batch/opp-commons/build.gradle.kts' line: 171 Could not resolve all artifacts for configuration ':opp-commons:classpath'. > Could not resolve org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23. Required by: project :opp-commons > org.jetbrains.kotlin.jvm:org.jetbrains.kotlin.jvm.gradle.plugin:1.9.23 > The consumer was configured to find a runtime of a component compatible with Java 11, packaged as a jar, and its dependencies declared externally. However we cannot choose between the following variants of org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23: - gradle70JavadocElements - gradle70RuntimeElements - gradle70SourcesElements - gradle71JavadocElements - gradle71RuntimeElements - gradle71SourcesElements - gradle74JavadocElements - gradle74RuntimeElements - gradle74SourcesElements - gradle75JavadocElements - gradle75RuntimeElements - gradle75SourcesElements - gradle76JavadocElements - gradle76RuntimeElements - gradle76SourcesElements - gradle80JavadocElements - gradle80RuntimeElements - gradle80SourcesElements - gradle81JavadocElements - gradle81RuntimeElements - gradle81SourcesElements - gradle82JavadocElements - gradle82RuntimeElements - gradle82SourcesElements - javadocElements - runtimeElementsWithFixedAttribute - sourcesElements All of them match the consumer attributes: - Variant 'gradle70JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.0' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle70RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '7.0' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle70SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.0' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle71JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.1' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle71RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '7.1' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle71SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.1' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle74JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.4' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle74RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '7.4' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle74SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.4' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle75JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.5' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle75RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '7.5' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle75SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.5' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle76JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.6' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle76RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '7.6' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle76SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '7.6' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle80JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '8.0' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle80RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '8.0' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle80SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '8.0' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle81JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '8.1' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle81RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '8.1' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle81SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '8.1' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle82JavadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '8.2' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle82RuntimeElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides attribute 'org.gradle.plugin.api-version' with value '8.2' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'gradle82SourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides attribute 'org.gradle.plugin.api-version' with value '8.2' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'javadocElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides javadocs but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides release status but the consumer didn't ask for it - Variant 'runtimeElementsWithFixedAttribute' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Unmatched attributes: - Provides a library but the consumer didn't ask for it - Provides attribute 'org.gradle.jvm.environment' with value 'standard-jvm' but the consumer didn't ask for it - Provides release status but the consumer didn't ask for it - Variant 'sourcesElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a runtime of a component, and its dependencies declared externally: - Unmatched attributes: - Provides documentation but the consumer didn't ask for it - Provides sources but the consumer didn't ask for it - Doesn't say anything about its target Java version (required compatibility with Java 11) - Doesn't say anything about its elements (required them packaged as a jar) - Provides release status but the consumer didn't ask for it The following variants were also considered but didn't match the requested attributes: - Variant 'apiElementsWithFixedAttribute' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle70ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle71ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle74ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle75ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle76ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle80ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle81ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component - Variant 'gradle82ApiElements' capability org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23 declares a component compatible with Java 8, packaged as a jar, and its dependencies declared externally: - Incompatible because this component declares an API of a component and the consumer needed a runtime of a component * Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.
最新发布
07-05
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值