readme and examples

sindresorhus · Mar 1, 2020 · 27177d5 · 27177d5
1 parent 0f090d9
commit 27177d5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -5,21 +5,25 @@ declare namespace cpy {
 	interface SourceFile {
 		/**
 		Resolved path to file.
+		@example `/tmp/foo.bar`
 		*/
 		readonly path: string,
 
 		/**
 		Filename.
+		@example `foo.bar`
 		*/
 		readonly name: string,
 
 		/**
 		Filename without extension.
+		@example `foo`
 		*/
 		readonly nameWithoutExtension: string,
 
 		/**
 		File extension.
+		@example `.bar`
 		*/
 		readonly extension: string,
 	}

diff --git a/readme.md b/readme.md
@@ -129,31 +129,25 @@ const cpy = require('cpy');
 
 Type: `string`
 
-Path to file.
-
-###### resolvedPath
-
-Type: `string`
-
-Resolved path to file.
+Resolved path to file. Example: `/tmp/foo.bar`.
 
 ###### name
 
 Type: `string`
 
-File name.
+Filename. Example: `foo.bar`.
 
 ###### nameWithoutExtension
 
 Type: `string`
 
-File name without extension.
+File name without extension. Example: `foo`.
 
 ###### extension
 
 Type: `string`
 
-File extension.
+File extension. Example: `.bar`.
 
 
 ## Progress reporting