@osdk/typescript-sdk-docs 0.4.0-beta.3 → 0.4.0-beta.5

package/build/cjs/index.cjs

@@ -327,7 +327,7 @@ var snippets = {
           "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\nimport type { Osdk, PageResult, Result } from "@osdk/client";\n\nconst response:  Result<PageResult<Osdk.Instance<{{objectType}}>>>\n    = await client({{objectType}}).fetchPageWithErrors({ $pageSize: 30 });\n\n// To fetch a page without a result wrapper, use fetchPage instead\nconst responseNoErrorWrapper: PageResult<Osdk.Instance<{{objectType}}>>\n    = await client({{objectType}}).fetchPage({ $pageSize: 30 });\n'
         }],
         "loadAllObjectsReference": [{
-          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\nimport type { Osdk } from "@osdk/client";\n\nconst objects: Osdk.Instance<{{objectType}}>[]= [];\n\nfor await(const obj of client({{objectType}}).asyncIter()) {\n    objects.push(obj);\n}\nconst object = objects[0];'
+          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\nimport type { Osdk } from "@osdk/client";\n\nasync function getAll(): Promise<Array<Osdk.Instance<{{objectType}}>>> {\n    const objects: Osdk.Instance<{{objectType}}>[]= [];\n    for await(const obj of client({{objectType}}).asyncIter()) {\n        objects.push(obj);\n    }\n\n    return objects;\n}\n\n// If Array.fromAsync() is available in your target environment\nfunction getAllFromAsync(): Promise<Array<Osdk.Instance<{{objectType}}>>> {\n    return Array.fromAsync(client({{objectType}}).asyncIter());\n}'
         }],
         "loadLinkedObjectReference": [{
           "template": 'import { {{sourceObjectType}}, {{linkedObjectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\nimport { type Osdk, type Result } from "@osdk/client";\n\nfunction getLinked{{linkedObjectType}}(source: Osdk.Instance<{{sourceObjectType}}>, linkedObjectPrimaryKey: {{linkedPrimaryKeyPropertyV2.type}}): Result<Osdk.Instance<{{linkedObjectType}}>>\n{\n    return source.$link.{{linkApiName}}.fetchOneWithErrors(linkedObjectPrimaryKey);\n}\n\n// You can also get a linked object without the result wrapper\nfunction getLinkedNoWrapper{{linkedObjectType}}(source: Osdk.Instance<{{sourceObjectType}}>, linkedObjectPrimaryKey: {{linkedPrimaryKeyPropertyV2.type}}): Osdk.Instance<{{linkedObjectType}}> {\n    return source.$link.{{linkApiName}}.fetchOne(linkedObjectPrimaryKey);\n}',
@@ -572,10 +572,10 @@ var snippets = {
           "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\nconst {{objectType}}WithExpression = await client({{objectType}})\n    .withProperties({\n      "newPropertyName": (baseObjectSet) =>\n          {{^isExtractPart}} \n          baseObjectSet.pivotTo("{{linkName}}")\n              .selectProperty("{{property}}")\n              .{{operation}}(baseObjectSet.pivotTo("{{linkName}}").selectProperty("{{property}}"))\n          {{/isExtractPart}}\n          {{#isExtractPart}}\n          baseObjectSet.pivotTo("{{linkName}}")\n              .selectProperty("{{property}}").{{operation}}("DAY")\n          {{/isExtractPart}}\n    });'
         }],
         "nearestNeighborsTextQuery": [{
-          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\nconst result = await client({{objectType}})\n  .nearestNeighbors("coffee", 5, "{{vectorProperty}}")\n  .fetchPage();'
+          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\nconst result = await client({{objectType}})\n  .nearestNeighbors("coffee", 5, "{{property}}")\n  .fetchPage();'
         }],
         "nearestNeighborsVectorQuery": [{
-          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\n// Note that this vector maps to an arbitrary string\n// It must match the dimension of the "{{vectorProperty}}" property: {{vectorDimensionSize}}\nconst vector_query = Array.from({ length: {{vectorDimensionSize}} }, () => 0.3),\nconst result = await client({{objectType}})\n  .nearestNeighbors(vector_query, 5, "{{vectorProperty}}")\n  .fetchPage();'
+          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\n// Note that this vector maps to an arbitrary string\n// It must match the dimension of the "{{property}}" property: {{vectorDimensionSize}}\nconst vector_query = Array.from({ length: {{vectorDimensionSize}} }, () => 0.3),\nconst result = await client({{objectType}})\n  .nearestNeighbors(vector_query, 5, "{{property}}")\n  .fetchPage();'
         }]
       }
     }