@@ -100,19 +100,19 @@ export interface NapiWatchOptions {
100100}
101101export interface NapiProjectOptions {
102102 /**
103- * An absolute root path from which all files must be nested under. Trying to access
104- * a file outside this root will fail, so think of this as a chroot.
103+ * An absolute root path (Unix or Windows path) from which all files must be nested under.
104+ * Trying to access a file outside this root will fail, so think of this as a chroot.
105105 * E.g. `/home/user/projects/my-repo`.
106106 */
107107 rootPath : RcStr
108108 /**
109- * A path which contains the app/pages directories, relative to [`Project::root_path`].
110- * E.g. `apps/my-app`
109+ * A path which contains the app/pages directories, relative to [`Project::root_path`], always
110+ * Unix path. E.g. `apps/my-app`
111111 */
112112 projectPath : RcStr
113113 /**
114- * A path where to emit the build outputs, relative to [`Project::project_path`].
115- * Corresponds to next.config.js's `distDir`.
114+ * A path where to emit the build outputs, relative to [`Project::project_path`], always Unix
115+ * path. Corresponds to next.config.js's `distDir`.
116116 * E.g. `.next`
117117 */
118118 distDir : RcStr
@@ -151,19 +151,20 @@ export interface NapiProjectOptions {
151151/** [NapiProjectOptions] with all fields optional. */
152152export interface NapiPartialProjectOptions {
153153 /**
154- * An absolute root path from which all files must be nested under. Trying to access
155- * a file outside this root will fail, so think of this as a chroot.
154+ * An absolute root path (Unix or Windows path) from which all files must be nested under.
155+ * Trying to access a file outside this root will fail, so think of this as a chroot.
156156 * E.g. `/home/user/projects/my-repo`.
157157 */
158158 rootPath ?: RcStr
159159 /**
160- * A path which contains the app/pages directories, relative to [`Project::root_path`].
160+ * A path which contains the app/pages directories, relative to [`Project::root_path`], always
161+ * a Unix path.
161162 * E.g. `apps/my-app`
162163 */
163164 projectPath ?: RcStr
164165 /**
165- * A path where to emit the build outputs, relative to [`Project::project_path`].
166- * Corresponds to next.config.js's `distDir`.
166+ * A path where to emit the build outputs, relative to [`Project::project_path`], always a
167+ * Unix path. Corresponds to next.config.js's `distDir`.
167168 * E.g. `.next`
168169 */
169170 distDir ?: RcStr | undefined | null
0 commit comments