Skip to content

Commit 7033f67

Browse files
committed
added docs link for namespace deprecation
1 parent 52c4295 commit 7033f67

File tree

14 files changed

+36
-2
lines changed

14 files changed

+36
-2
lines changed

src/api/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { FetcherResponseInfo } from '@/src/api/fetch/types';
1717
/**
1818
* Response object from an API call
1919
*
20-
* @deprecated Use {@link FetcherResponseInfo} instead (synonymous type)
20+
* @deprecated - Use {@link FetcherResponseInfo} instead (synonymous type)
2121
*
2222
* @public
2323
*/

src/client/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export interface DataAPIClientOptions {
136136
*
137137
* The two are functionally equivalent; this is provided for backwards compatibility.
138138
*
139-
* @deprecated Use the {@link DataAPIClientOptions.httpOptions} property instead.
139+
* @deprecated - Use the {@link DataAPIClientOptions.httpOptions} property instead.
140140
*
141141
* @see DefaultHttpClientOptions
142142
*/

src/data-api/collection.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
125125
* This is now a deprecated alias for the strictly equivalent {@link Collection.keyspace}, and will be removed
126126
* in an upcoming major version.
127127
*
128+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
129+
*
128130
* @deprecated - Prefer {@link Collection.keyspace} instead.
129131
*/
130132
public readonly namespace!: string;

src/data-api/cursor.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ export class FindCursor<T, TRaw extends SomeDoc = SomeDoc> {
117117
* This is now a deprecated alias for the strictly equivalent {@link FindCursor.keyspace}, and will be removed
118118
* in an upcoming major version.
119119
*
120+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
121+
*
120122
* @deprecated - Prefer {@link FindCursor.keyspace} instead.
121123
*/
122124
public get namespace(): string {

src/data-api/db.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ export class Db {
170170
* This is now a deprecated alias for the strictly equivalent {@link Db.keyspace}, and will be removed
171171
* in an upcoming major version.
172172
*
173+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
174+
*
173175
* @deprecated - Prefer {@link Db.keyspace} instead.
174176
*/
175177
public get namespace(): string {
@@ -243,6 +245,8 @@ export class Db {
243245
* This is now a deprecated alias for the strictly equivalent {@link Db.useKeyspace}, and will be removed
244246
* in an upcoming major version.
245247
*
248+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
249+
*
246250
* @deprecated - Prefer {@link Db.useKeyspace} instead.
247251
*/
248252
public useNamespace(keyspace: string) {

src/data-api/errors.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,8 @@ export class CollectionNotFoundError extends DataAPIError {
295295
* This is now a deprecated alias for the strictly equivalent {@link CollectionNotFoundError.keyspace}, and will be removed
296296
* in an upcoming major version.
297297
*
298+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
299+
*
298300
* @deprecated - Prefer {@link CollectionNotFoundError.keyspace} instead.
299301
*/
300302
public readonly namespace: string;
@@ -338,6 +340,8 @@ export class CollectionAlreadyExistsError extends DataAPIError {
338340
* This is now a deprecated alias for the strictly equivalent {@link CollectionAlreadyExistsError.keyspace}, and will be removed
339341
* in an upcoming major version.
340342
*
343+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
344+
*
341345
* @deprecated - Prefer {@link CollectionAlreadyExistsError.keyspace} instead.
342346
*/
343347
public readonly namespace: string;

src/data-api/events.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ export abstract class CommandEvent {
7575
* This is now a deprecated alias for the strictly equivalent {@link CommandEvent.keyspace}, and will be removed
7676
* in an upcoming major version.
7777
*
78+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
79+
*
7880
* @deprecated - Prefer {@link CommandEvent.keyspace} instead.
7981
*/
8082
public readonly namespace: string;

src/data-api/types/collections/collections-common.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ export interface WithKeyspace {
235235
* This is now a deprecated alias for the strictly equivalent {@link WithKeyspace.keyspace}, and will be removed
236236
* in an upcoming major version.
237237
*
238+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
239+
*
238240
* @deprecated - Prefer {@link WithKeyspace.keyspace} instead.
239241
*/
240242
namespace?: string

src/data-api/types/collections/command.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ export interface RunCommandOptions extends WithTimeout {
3939
* This is now a deprecated alias for the strictly equivalent {@link RunCommandOptions.keyspace}, and will be removed
4040
* in an upcoming major version.
4141
*
42+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
43+
*
4244
* @deprecated - Prefer {@link RunCommandOptions.keyspace} instead.
4345
*/
4446
namespace?: string | null,

src/data-api/types/misc/spawn-db.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ export interface DbSpawnOptions {
6767
* This is now a deprecated alias for the strictly equivalent {@link DbSpawnOptions.keyspace}, and will be removed
6868
* in an upcoming major version.
6969
*
70+
* https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
71+
*
7072
* @deprecated - Prefer {@link DbSpawnOptions.keyspace} instead.
7173
*/
7274
namespace?: string,

0 commit comments

Comments
 (0)