@xyd-js/sources 0.0.1-xyd.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +3 -0
  3. package/TODO.md +6 -0
  4. package/dist/example.cjs +642 -0
  5. package/dist/example.cjs.map +1 -0
  6. package/dist/example.d.cts +2 -0
  7. package/dist/example.d.ts +2 -0
  8. package/dist/example.js +618 -0
  9. package/dist/example.js.map +1 -0
  10. package/dist/index.cjs +647 -0
  11. package/dist/index.cjs.map +1 -0
  12. package/dist/index.d.cts +83 -0
  13. package/dist/index.d.ts +83 -0
  14. package/dist/index.js +612 -0
  15. package/dist/index.js.map +1 -0
  16. package/docs/README.md +20 -0
  17. package/docs/classes/ExampleClass.md +35 -0
  18. package/docs/functions/gqlSchemaToReferences.md +27 -0
  19. package/docs/functions/helloWorld.md +17 -0
  20. package/docs/functions/helloWorldV2.md +33 -0
  21. package/docs/functions/helloWorldV3.md +35 -0
  22. package/docs.json +551 -0
  23. package/example/package-a/package.json +4 -0
  24. package/example/package-a/src/index.ts +56 -0
  25. package/example/package-a/tsconfig.json +23 -0
  26. package/example/package-b/package.json +7 -0
  27. package/example/package-b/src/billing.ts +193 -0
  28. package/example/package-b/src/index.ts +8 -0
  29. package/example/package-b/tsconfig.json +20 -0
  30. package/package.json +22 -0
  31. package/references_todo.json +220 -0
  32. package/src/SignatureText.ts +214 -0
  33. package/src/TypeDocTransformer.ts +572 -0
  34. package/src/index.ts +45 -0
  35. package/test-cmd/index.ts +62 -0
  36. package/tsconfig.json +30 -0
  37. package/tsup.config.ts +39 -0
package/docs/README.md ADDED
@@ -0,0 +1,20 @@
1
+ **@xyd-sources-examples/package-a**
2
+
3
+ ***
4
+
5
+ # @xyd-sources-examples/package-a
6
+
7
+ ## Classes
8
+
9
+ | Class | Description |
10
+ | ------ | ------ |
11
+ | [ExampleClass](classes/ExampleClass.md) | Returns a personalized hello world message. |
12
+
13
+ ## Functions
14
+
15
+ | Function | Description |
16
+ | ------ | ------ |
17
+ | [gqlSchemaToReferences](functions/gqlSchemaToReferences.md) | Converts a GraphQL schema file to references. |
18
+ | [helloWorld](functions/helloWorld.md) | Returns a hello world message. |
19
+ | [helloWorldV2](functions/helloWorldV2.md) | Returns a personalized hello world message. |
20
+ | [helloWorldV3](functions/helloWorldV3.md) | Returns a personalized hello world message. |
package/docs/classes/ExampleClass.md ADDED
@@ -0,0 +1,35 @@
1
+ [**@xyd-sources-examples/package-a**](../README.md)
2
+
3
+ ***
4
+
5
+ [@xyd-sources-examples/package-a](../README.md) / ExampleClass
6
+
7
+ # Class: ExampleClass
8
+
9
+ Returns a personalized hello world message.
10
+
11
+ ## Constructors
12
+
13
+ ### Constructor
14
+
15
+ ```ts
16
+ new ExampleClass(): ExampleClass
17
+ ```
18
+
19
+ #### Returns
20
+
21
+ `ExampleClass`
22
+
23
+ ## Methods
24
+
25
+ ### helloWorld()
26
+
27
+ ```ts
28
+ helloWorld(): string
29
+ ```
30
+
31
+ Returns a hello world message.
32
+
33
+ #### Returns
34
+
35
+ `string`
package/docs/functions/gqlSchemaToReferences.md ADDED
@@ -0,0 +1,27 @@
1
+ [**@xyd-sources-examples/package-a**](../README.md)
2
+
3
+ ***
4
+
5
+ [@xyd-sources-examples/package-a](../README.md) / gqlSchemaToReferences
6
+
7
+ # Function: gqlSchemaToReferences()
8
+
9
+ ```ts
10
+ function gqlSchemaToReferences(schemaLocation): Promise<[]>
11
+ ```
12
+
13
+ Converts a GraphQL schema file to references.
14
+
15
+ ## Parameters
16
+
17
+ ### schemaLocation
18
+
19
+ `string`
20
+
21
+ The location of the schema file.
22
+
23
+ ## Returns
24
+
25
+ `Promise`\<\[\]\>
26
+
27
+ references
package/docs/functions/helloWorld.md ADDED
@@ -0,0 +1,17 @@
1
+ [**@xyd-sources-examples/package-a**](../README.md)
2
+
3
+ ***
4
+
5
+ [@xyd-sources-examples/package-a](../README.md) / helloWorld
6
+
7
+ # Function: helloWorld()
8
+
9
+ ```ts
10
+ function helloWorld(): string
11
+ ```
12
+
13
+ Returns a hello world message.
14
+
15
+ ## Returns
16
+
17
+ `string`
package/docs/functions/helloWorldV2.md ADDED
@@ -0,0 +1,33 @@
1
+ [**@xyd-sources-examples/package-a**](../README.md)
2
+
3
+ ***
4
+
5
+ [@xyd-sources-examples/package-a](../README.md) / helloWorldV2
6
+
7
+ # Function: helloWorldV2()
8
+
9
+ ```ts
10
+ function helloWorldV2(name, enthusiastic): string
11
+ ```
12
+
13
+ Returns a personalized hello world message.
14
+
15
+ ## Parameters
16
+
17
+ ### name
18
+
19
+ `string`
20
+
21
+ Name of the person to greet.
22
+
23
+ ### enthusiastic
24
+
25
+ `boolean` = `false`
26
+
27
+ If true, adds an exclamation point to the greeting.
28
+
29
+ ## Returns
30
+
31
+ `string`
32
+
33
+ A greeting message string.
package/docs/functions/helloWorldV3.md ADDED
@@ -0,0 +1,35 @@
1
+ [**@xyd-sources-examples/package-a**](../README.md)
2
+
3
+ ***
4
+
5
+ [@xyd-sources-examples/package-a](../README.md) / helloWorldV3
6
+
7
+ # Function: helloWorldV3()
8
+
9
+ ```ts
10
+ function helloWorldV3<T>(name): string
11
+ ```
12
+
13
+ Returns a personalized hello world message.
14
+
15
+ ## Type Parameters
16
+
17
+ ### T
18
+
19
+ `T`
20
+
21
+ The type of the name.
22
+
23
+ ## Parameters
24
+
25
+ ### name
26
+
27
+ `T`
28
+
29
+ Name of the person to greet.
30
+
31
+ ## Returns
32
+
33
+ `string`
34
+
35
+ A greeting message string.