This is an automated email from the ASF dual-hosted git repository. colegreer pushed a commit to branch tsDocMigration in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit ee871723a11bd0b911ebc4199845a73ccc91e5ca Author: Cole Greer <[email protected]> AuthorDate: Tue Mar 31 12:36:58 2026 -0700 Update JS-Doc style comments to TS-Doc style --- gremlin-js/gremlin-javascript/lib/driver/client.ts | 19 +------- .../gremlin-javascript/lib/driver/connection.ts | 14 +----- .../lib/driver/driver-remote-connection.ts | 15 +------ .../lib/process/anonymous-traversal.ts | 12 ++--- .../lib/process/graph-traversal.ts | 2 +- .../lib/process/traversal-strategy.ts | 51 +++++++++++----------- .../gremlin-javascript/lib/process/traversal.ts | 2 - 7 files changed, 37 insertions(+), 78 deletions(-) diff --git a/gremlin-js/gremlin-javascript/lib/driver/client.ts b/gremlin-js/gremlin-javascript/lib/driver/client.ts index e44dc345b8..35cffc28f6 100644 --- a/gremlin-js/gremlin-javascript/lib/driver/client.ts +++ b/gremlin-js/gremlin-javascript/lib/driver/client.ts @@ -33,7 +33,7 @@ export type RequestOptions = { params?: Record<string, any>; }; -type ClientOptions = ConnectionOptions & RequestOptions & { processor?: string }; +export type ClientOptions = ConnectionOptions & RequestOptions & { processor?: string }; /** * A {@link Client} contains methods to send messages to a Gremlin Server. @@ -44,22 +44,7 @@ export default class Client { /** * Creates a new instance of {@link Client}. * @param {String} url The resource uri. - * @param {Object} [options] The connection options. - * @param {Array} [options.ca] Trusted certificates. - * @param {String|Array|Buffer} [options.cert] The certificate key. - * @param {String|Buffer} [options.pfx] The private key, certificate, and CA certs. - * @param {GraphBinaryReader} [options.reader] The reader to use. - * @param {Boolean} [options.rejectUnauthorized] Determines whether to verify or not the server certificate. - * @param {String} [options.traversalSource] The traversal source. Defaults to: 'g'. - * @param {GraphBinaryWriter} [options.writer] The writer to use. - * @param {Authenticator} [options.authenticator] The authentication handler to use. - * @param {Object} [options.headers] An associative array containing the additional header key/values for the initial request. - * @param {Boolean} [options.enableUserAgentOnConnect] Determines if a user agent will be sent during connection handshake. Defaults to: true - * @param {String} [options.processor] The name of the opProcessor to use, leave it undefined or set 'session' when session mode. - * @param {String} [options.session] The sessionId of Client in session mode. Defaults to null means session-less Client. - * @param {http.Agent} [options.agent] The http.Agent implementation to use. - * @param {RequestInterceptor|RequestInterceptor[]} [options.interceptors] One or more request interceptors to apply before each HTTP request. - * @constructor + * @param {ClientOptions} [options] The connection options. */ constructor( url: string, diff --git a/gremlin-js/gremlin-javascript/lib/driver/connection.ts b/gremlin-js/gremlin-javascript/lib/driver/connection.ts index 9851f9d3b2..35e7e09285 100644 --- a/gremlin-js/gremlin-javascript/lib/driver/connection.ts +++ b/gremlin-js/gremlin-javascript/lib/driver/connection.ts @@ -81,19 +81,7 @@ export default class Connection extends EventEmitter { /** * Creates a new instance of {@link Connection}. * @param {String} url The resource uri. - * @param {Object} [options] The connection options. - * @param {Array} [options.ca] Trusted certificates. - * @param {String|Array|Buffer} [options.cert] The certificate key. - * @param {String|Buffer} [options.pfx] The private key, certificate, and CA certs. - * @param {GraphBinaryReader} [options.reader] The reader to use. - * @param {Boolean} [options.rejectUnauthorized] Determines whether to verify or not the server certificate. - * @param {String} [options.traversalSource] The traversal source. Defaults to: 'g'. - * @param {GraphBinaryWriter} [options.writer] The writer to use. Set to null to skip serialization. - * @param {Object} [options.headers] An associative array containing the additional header key/values for the initial request. - * @param {Boolean} [options.enableUserAgentOnConnect] Determines if a user agent will be sent during connection handshake. Defaults to: true - * @param {http.Agent} [options.agent] The http.Agent implementation to use. - * @param {RequestInterceptor|RequestInterceptor[]} [options.interceptors] One or more request interceptors to apply before each HTTP request. - * @constructor + * @param {ConnectionOptions} [options] The connection options. */ constructor( readonly url: string, diff --git a/gremlin-js/gremlin-javascript/lib/driver/driver-remote-connection.ts b/gremlin-js/gremlin-javascript/lib/driver/driver-remote-connection.ts index c59c010834..b6624b69c7 100644 --- a/gremlin-js/gremlin-javascript/lib/driver/driver-remote-connection.ts +++ b/gremlin-js/gremlin-javascript/lib/driver/driver-remote-connection.ts @@ -30,7 +30,7 @@ import GremlinLang from '../process/gremlin-lang.js'; import { ConnectionOptions } from './connection.js'; /** - * Represents the default {@link RemoteConnection} implementation. + * Represents the default `RemoteConnection` implementation. */ export default class DriverRemoteConnection extends RemoteConnection { private readonly _client: Client; @@ -39,19 +39,6 @@ export default class DriverRemoteConnection extends RemoteConnection { * Creates a new instance of {@link DriverRemoteConnection}. * @param {String} url The resource uri. * @param {ConnectionOptions} [options] The connection options. - * @param {Array} [options.ca] Trusted certificates. - * @param {String|Array|Buffer} [options.cert] The certificate key. - * @param {String|Buffer} [options.pfx] The private key, certificate, and CA certs. - * @param {GraphBinaryReader} [options.reader] The reader to use. - * @param {Boolean} [options.rejectUnauthorized] Determines whether to verify or not the server certificate. - * @param {String} [options.traversalSource] The traversal source. Defaults to: 'g'. - * @param {GraphBinaryWriter} [options.writer] The writer to use. - * @param {Authenticator} [options.authenticator] The authentication handler to use. - * @param {Object} [options.headers] An associative array containing the additional header key/values for the initial request. - * @param {Boolean} [options.enableUserAgentOnConnect] Determines if a user agent will be sent during connection handshake. Defaults to: true - * @param {http.Agent} [options.agent] The http.Agent implementation to use. - * @param {RequestInterceptor|RequestInterceptor[]} [options.interceptors] One or more request interceptors to apply before each HTTP request. - * @constructor */ constructor(url: string, options: ConnectionOptions = {}) { super(url, options); diff --git a/gremlin-js/gremlin-javascript/lib/process/anonymous-traversal.ts b/gremlin-js/gremlin-javascript/lib/process/anonymous-traversal.ts index 03551d95d7..3432735ac3 100644 --- a/gremlin-js/gremlin-javascript/lib/process/anonymous-traversal.ts +++ b/gremlin-js/gremlin-javascript/lib/process/anonymous-traversal.ts @@ -30,9 +30,9 @@ import GremlinLang from './gremlin-lang.js'; */ export default class AnonymousTraversalSource { /** - * Creates a new instance of {@code AnonymousTraversalSource}. - * @param {Function} [traversalSourceClass] Optional {@code GraphTraversalSource} constructor. - * @param {Function} [traversalClass] Optional {@code GraphTraversal} constructor. + * Creates a new instance of `AnonymousTraversalSource`. + * @param {Function} [traversalSourceClass] Optional `GraphTraversalSource` constructor. + * @param {Function} [traversalClass] Optional `GraphTraversal` constructor. */ constructor( readonly traversalSourceClass?: typeof GraphTraversalSource, @@ -40,10 +40,10 @@ export default class AnonymousTraversalSource { ) {} /** - * Constructs an {@code AnonymousTraversalSource} which will then be configured to spawn a + * Constructs an `AnonymousTraversalSource` which will then be configured to spawn a * {@link GraphTraversalSource}. - * @param {Function} [traversalSourceClass] Optional {@code GraphTraversalSource} constructor. - * @param {Function} [traversalClass] Optional {@code GraphTraversalSource} constructor. + * @param {Function} [traversalSourceClass] Optional `GraphTraversalSource` constructor. + * @param {Function} [traversalClass] Optional `GraphTraversalSource` constructor. * @returns {AnonymousTraversalSource}. */ static traversal(traversalSourceClass?: typeof GraphTraversalSource, traversalClass?: typeof GraphTraversal) { diff --git a/gremlin-js/gremlin-javascript/lib/process/graph-traversal.ts b/gremlin-js/gremlin-javascript/lib/process/graph-traversal.ts index fc47bf4116..48362a148b 100644 --- a/gremlin-js/gremlin-javascript/lib/process/graph-traversal.ts +++ b/gremlin-js/gremlin-javascript/lib/process/graph-traversal.ts @@ -113,7 +113,7 @@ export class GraphTraversalSource { /** * Graph Traversal Source with method. * @param {String} key - * @param {Object} value if not specified, the value with default to {@code true} + * @param {Object} value if not specified, the value with default to `true` * @returns {GraphTraversalSource} */ with_(key: string, value: object | undefined = undefined): GraphTraversalSource { diff --git a/gremlin-js/gremlin-javascript/lib/process/traversal-strategy.ts b/gremlin-js/gremlin-javascript/lib/process/traversal-strategy.ts index 912e01a8dd..4cc52c4599 100644 --- a/gremlin-js/gremlin-javascript/lib/process/traversal-strategy.ts +++ b/gremlin-js/gremlin-javascript/lib/process/traversal-strategy.ts @@ -30,7 +30,6 @@ export class TraversalStrategies { /** * Creates a new instance of TraversalStrategies. * @param {TraversalStrategies} [parent] The parent strategies from where to clone the values from. - * @constructor */ constructor(parent?: TraversalStrategies) { if (parent) { @@ -106,7 +105,7 @@ export class ElementIdStrategy extends TraversalStrategy { export class HaltedTraverserStrategy extends TraversalStrategy { /** - * @param {String} haltedTraverserFactory full qualified class name in Java of a {@code HaltedTraverserFactory} implementation + * @param {String} haltedTraverserFactory full qualified class name in Java of a `HaltedTraverserFactory` implementation */ constructor({haltedTraverserFactory = ""}) { super({haltedTraverserFactory: haltedTraverserFactory}); @@ -127,14 +126,14 @@ export class OptionsStrategy extends TraversalStrategy { export class PartitionStrategy extends TraversalStrategy { /** - * @param {Object} [options] - * @param {String} [options.partitionKey] name of the property key to partition by - * @param {String} [options.writePartition] the value of the currently write partition - * @param {Array<String>} [options.readPartitions] list of strings representing the partitions to include for reads - * @param {boolean} [options.includeMetaProperties] determines if meta-properties should be included in partitioning defaulting to false + * @param options + * @param options.partitionKey - name of the property key to partition by + * @param options.writePartition - the value of the currently write partition + * @param options.readPartitions - list of strings representing the partitions to include for reads + * @param options.includeMetaProperties - determines if meta-properties should be included in partitioning defaulting to false */ - constructor(options: TraversalStrategyConfiguration) { - super(options); + constructor({partitionKey = '', writePartition = '', readPartitions = [], includeMetaProperties = false} = {}) { + super({partitionKey, writePartition, readPartitions, includeMetaProperties}); } } @@ -146,14 +145,14 @@ export class ProfileStrategy extends TraversalStrategy { export class SubgraphStrategy extends TraversalStrategy { /** - * @param {Object} [options] - * @param {GraphTraversal} [options.vertices] name of the property key to partition by - * @param {GraphTraversal} [options.edges] the value of the currently write partition - * @param {GraphTraversal} [options.vertexProperties] list of strings representing the partitions to include for reads - * @param {boolean} [options.checkAdjacentVertices] enables the strategy to apply the {@code vertices} filter to the adjacent vertices of an edge. + * @param options + * @param options.vertices - traversal to filter vertices + * @param options.edges - traversal to filter edges + * @param options.vertexProperties - traversal to filter vertex properties + * @param options.checkAdjacentVertices - enables the strategy to apply the `vertices` filter to the adjacent vertices of an edge. */ - constructor(options: TraversalStrategyConfiguration) { - super(options); + constructor({vertices = undefined, edges = undefined, vertexProperties = undefined, checkAdjacentVertices = false} = {}) { + super({vertices, edges, vertexProperties, checkAdjacentVertices}); if (this.configuration.vertices instanceof Traversal) { this.configuration.vertices = this.configuration.vertices.gremlinLang; } @@ -168,11 +167,11 @@ export class SubgraphStrategy extends TraversalStrategy { export class ProductiveByStrategy extends TraversalStrategy { /** - * @param {Object} [options] - * @param {Array<String>} [options.productiveKeys] set of keys that will always be productive + * @param options + * @param options.productiveKeys - set of keys that will always be productive */ - constructor(options: TraversalStrategyConfiguration) { - super(options); + constructor({productiveKeys = []} = {}) { + super({productiveKeys}); } } @@ -313,8 +312,9 @@ export class ReadOnlyStrategy extends TraversalStrategy { export class EdgeLabelVerificationStrategy extends TraversalStrategy { /** - * @param {boolean} logWarnings determines if warnings should be written to the logger when verification fails - * @param {boolean} throwException determines if exceptions should be thrown when verifications fails + * @param options + * @param options.logWarnings - determines if warnings should be written to the logger when verification fails + * @param options.throwException - determines if exceptions should be thrown when verifications fails */ constructor({logWarnings = false, throwException = false} = {}) { super({ @@ -326,9 +326,10 @@ export class EdgeLabelVerificationStrategy extends TraversalStrategy { export class ReservedKeysVerificationStrategy extends TraversalStrategy { /** - * @param {boolean} logWarnings determines if warnings should be written to the logger when verification fails - * @param {boolean} throwException determines if exceptions should be thrown when verifications fails - * @param {Array<String>} keys the list of reserved keys to verify + * @param options + * @param options.logWarnings - determines if warnings should be written to the logger when verification fails + * @param options.throwException - determines if exceptions should be thrown when verifications fails + * @param options.keys - the list of reserved keys to verify */ constructor({ logWarnings = false, throwException = false, keys = ['id', 'label'] } = {}) { super({ diff --git a/gremlin-js/gremlin-javascript/lib/process/traversal.ts b/gremlin-js/gremlin-javascript/lib/process/traversal.ts index dad0650a77..5b4b6157be 100644 --- a/gremlin-js/gremlin-javascript/lib/process/traversal.ts +++ b/gremlin-js/gremlin-javascript/lib/process/traversal.ts @@ -255,7 +255,6 @@ class PeerPressure { export class P<T1 = any, T2 = any> { /** * Represents an operation. - * @constructor */ constructor( public operator: string, @@ -379,7 +378,6 @@ function createP(operator: string, args: any) { export class TextP<T1 = any, T2 = any> { /** * Represents an operation. - * @constructor */ constructor( public operator: string,
