Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-2744] Replace FQLX beta doc links in beta branch #256

Merged
merged 1 commit into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/client-configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export interface ClientConfiguration {
linearized?: boolean;

/**
* Controls what Javascript type to deserialize {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#long | Fauna longs} to.
* Controls what Javascript type to deserialize {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#long | Fauna longs} to.
* Use 'number' to deserialize longs to number. Use 'bigint' to deserialize to bigint. Defaults to 'number'.
* Note, for extremely large maginitude numbers Javascript's number will lose precision; as Javascript's
* 'number' can only support +/- 2^53-1 whereas Fauna's long is 64 bit. If this is detected, a warning will
Expand Down Expand Up @@ -167,7 +167,8 @@ export type StreamClientConfiguration = {
httpStreamClient: HTTPStreamClient;

/**
* Controls what Javascript type to deserialize {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#long | Fauna longs} to.
* Controls what Javascript type to deserialize {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#long | Fauna longs} to.
*
* @see {@link ClientConfiguration.long_type}
*/
long_type: "number" | "bigint";
Expand Down
10 changes: 0 additions & 10 deletions src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,6 @@ export class ServiceError extends FaunaError {
* QueryRuntimeError's occur when a bug in your query causes an invalid execution
* to be requested.
* The 'code' field will vary based on the specific error cause.
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
*/
export class QueryRuntimeError extends ServiceError {
constructor(failure: QueryFailure, httpStatus?: number) {
Expand All @@ -85,8 +83,6 @@ export class QueryRuntimeError extends ServiceError {
/**
* An error due to a "compile-time" check of the query
* failing.
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
*/
export class QueryCheckError extends ServiceError {
constructor(failure: QueryFailure, httpStatus?: number) {
Expand All @@ -101,8 +97,6 @@ export class QueryCheckError extends ServiceError {
/**
* An error due to an invalid request to Fauna. Either the request body was not
* valid JSON or did not conform to the API specification
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
*/
export class InvalidRequestError extends ServiceError {
constructor(failure: QueryFailure, httpStatus?: number) {
Expand All @@ -116,8 +110,6 @@ export class InvalidRequestError extends ServiceError {

/**
* A runtime error due to failing schema constraints.
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
*/
export class ConstraintFailureError extends ServiceError {
/**
Expand All @@ -142,8 +134,6 @@ export class ConstraintFailureError extends ServiceError {

/**
* An error due to calling the FQL `abort` function.
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
*/
export class AbortError extends ServiceError {
/**
Expand Down
4 changes: 2 additions & 2 deletions src/values/date-time.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import * as PARSE from "../regex";
* Converting to a Javascript date before sending to Fauna could result in loss
* of precision.
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/builtin_functions/time/time}
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#time}
*/
export class TimeStub {
readonly isoString: string;
Expand Down Expand Up @@ -104,7 +104,7 @@ export class TimeStub {
* be taken to specify the desired date, since Javascript `Date`s use local
* timezone info by default.
*
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/builtin_functions/date/date}
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#date}
*/
export class DateStub {
readonly dateString: string;
Expand Down
12 changes: 12 additions & 0 deletions src/values/doc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import { TimeStub } from "./date-time";
* const id = userDocumentReference.id;
* id === "101"; // returns true
* ```
*
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#special}
*/
export class DocumentReference {
readonly coll: Module;
Expand Down Expand Up @@ -57,6 +59,8 @@ export class DocumentReference {
*
* @remarks The {@link Document} class cannot be generic because classes cannot
* extend generic type arguments.
*
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#special}
*/
export class Document extends DocumentReference {
readonly ts: TimeStub;
Expand Down Expand Up @@ -97,6 +101,8 @@ export class Document extends DocumentReference {
* const collectionName = namedDocumentReference.name;
* collectionName === "Users"; // returns true
* ```
*
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#special}
*/
export class NamedDocumentReference {
readonly coll: Module;
Expand Down Expand Up @@ -145,6 +151,8 @@ export class NamedDocumentReference {
*
* const metadata = userCollection.data.metadata;
* ```
*
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#special}
*/
export class NamedDocument<
T extends QueryValueObject = Record<string, never>,
Expand Down Expand Up @@ -187,6 +195,8 @@ export class NamedDocument<
* `);
* const allUserDocuments = response.data;
* ```
*
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#module}
*/
export class Module {
readonly name: string;
Expand Down Expand Up @@ -221,6 +231,8 @@ export class Module {
* const color = maybeUserDocument.color;
* }
* ```
*
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#nulldoc}
*/
export class NullDocument {
readonly ref: DocumentReference | NamedDocumentReference;
Expand Down
4 changes: 2 additions & 2 deletions src/values/set.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { QueryOptions, QueryValue } from "../wire-protocol";

/**
* A materialized view of a Set.
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#set}
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#set}
*/
export class Page<T extends QueryValue> {
/** A materialized page of data */
Expand All @@ -26,7 +26,7 @@ export class Page<T extends QueryValue> {
* A un-materialized Set. Typically received when a materialized Set contains
* another set, the EmbeddedSet does not contain any data to avoid potential
* issues such as self-reference and infinite recursion
* @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#set}
* @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#set}
*/
export class EmbeddedSet {
/**
Expand Down
2 changes: 1 addition & 1 deletion src/wire-protocol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export interface QueryOptions {
linearized?: boolean;

/**
* Controls what Javascript type to deserialize {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#long | Fauna longs} to.
* Controls what Javascript type to deserialize {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#long | Fauna longs} to.
* Use 'number' to deserialize longs to number. Use 'bigint' to deserialize to bigint. Defaults to 'number'.
* Note, for extremely large maginitude numbers Javascript's number will lose precision; as Javascript's
* 'number' can only support +/- 2^53-1 whereas Fauna's long is 64 bit. If this is detected, a warning will
Expand Down
Loading