Create allowances for specific areas

Question

Create allowances for specific areas

One of my methods involves the saving of an author using the .findOneAndUpdate function.

The structure of AuthorInterface is as follows:

    export interface AuthorInterface {
        name: string,
        bio: string,
        githubLink: string,
        stackoverflowLink: string,
        twitterLink: string,
        image: string,
        image_webp: string,
    }

In this particular scenario, I encounter a unique situation. The properties image and image_webp contain paths to images, making it impossible to simply overwrite their values. To address this, I have utilized Omit to exclude them from the AuthorInterface argument.

Despite that, TypeScript continues to raise errors when I use author: { ...author }, indicating that the fields image_webp and image are missing. How can I communicate to TypeScript that these two properties are not expected in the argument object?

    public saveAuthor(_id: mongoose.Types.ObjectId | string, author: Omit<AuthorInterface, "image" | "image_webp">): Promise<UserModelInterface | null> {
        return User.findOneAndUpdate({ _id }, { author: { ...author } }, { new: true }).exec()
    }

javascript mongodb typescript mongoose

Answer 1

Answer №1

Revise your AuthorInterface as shown below

export interface AuthorInterface {
    firstName: string,
    lastName: string,
    email: string,
    websiteLink: string,
    linkedinLink: string,
    image?: string,
    bio?: string,
}

Answer 2

Revise your AuthorInterface as shown below

export interface AuthorInterface {
    firstName: string,
    lastName: string,
    email: string,
    websiteLink: string,
    linkedinLink: string,
    image?: string,
    bio?: string,
}

Answer 3

Answer №2

Witness the elegance of TypeScript in action.

function updateAuthor(_id: mongoose.Types.ObjectId | string, author: unknown): Promise<UserModelInterface | null> {
    return User.findOneAndUpdate({ _id }, { author: author as AuthorInterface }, { new: true }).exec()
}

Answer 4

Witness the elegance of TypeScript in action.

function updateAuthor(_id: mongoose.Types.ObjectId | string, author: unknown): Promise<UserModelInterface | null> {
    return User.findOneAndUpdate({ _id }, { author: author as AuthorInterface }, { new: true }).exec()
}

Answer 5

Answer №3

Here is an example of my proposed solution:

import mongoose from 'mongoose'

interface AuthorDetails {
        name: string,
        bio: string,
        githubLink: string,
        stackoverflowLink: string,
        twitterLink: string,
}

type UpdateAuthor = Omit<AuthorDetails, "image" | "image_webp">;

/**
 * It is possible to update the User object/class using the following approach
 */
interface UserProfile {
        findOneAndUpdate: <T>(arg1: any, author: UpdateAuthor extends T ? UpdateAuthor : T, arg3: any) => any
}

/**
 * This is a mock User object used for testing purposes
 */
const UserProfile: UserProfile = {
        findOneAndUpdate: (...args: any[]) => { }
}

/**
 * When passing UpdateAuthor to findOneAndUpdate, it should function as intended
 */
function updateUserProfile(_id: mongoose.Types.ObjectId | string, author: UpdateAuthor) {
        return UserProfile.findOneAndUpdate({ _id }, { author: { ...author } }, { new: true }).exec()
}

/**
 * If there are any issues with this solution, please provide a minimal reproducible example
 */

Answer 6

Here is an example of my proposed solution:

import mongoose from 'mongoose'

interface AuthorDetails {
        name: string,
        bio: string,
        githubLink: string,
        stackoverflowLink: string,
        twitterLink: string,
}

type UpdateAuthor = Omit<AuthorDetails, "image" | "image_webp">;

/**
 * It is possible to update the User object/class using the following approach
 */
interface UserProfile {
        findOneAndUpdate: <T>(arg1: any, author: UpdateAuthor extends T ? UpdateAuthor : T, arg3: any) => any
}

/**
 * This is a mock User object used for testing purposes
 */
const UserProfile: UserProfile = {
        findOneAndUpdate: (...args: any[]) => { }
}

/**
 * When passing UpdateAuthor to findOneAndUpdate, it should function as intended
 */
function updateUserProfile(_id: mongoose.Types.ObjectId | string, author: UpdateAuthor) {
        return UserProfile.findOneAndUpdate({ _id }, { author: { ...author } }, { new: true }).exec()
}

/**
 * If there are any issues with this solution, please provide a minimal reproducible example
 */

Answer 7

Answer №4

When working on the saveAuthor function, it is important to note that only the author parameter is used for cloning and passing to User.findOneAndUpdate.

To clarify this further, you can define saveAuthor's parameter as:

author: Parameters<(typeof User)['findOneAndUpdate']>[1].author

This essentially means: "this function expects the same input as User.findOneAndUpdate."

A simpler approach would be to use the established type. Assuming that findOneAndUpdate requires an AuthorInterface in the 2nd parameter for the author property, you can simply write:

author: AuthorInterface

Furthermore, your concern about removing properties seems unnecessary:

"image and image_webp are image paths and therefore I cannot just override the values".

In the context of saveAuthor, you are not actually modifying these properties. The cloning operation using the spread operator { ...author } ensures that any modifications by User.findOneAndUpdate do not affect the original object.

Your confusion regarding types versus values is evident when referencing the Omit method. It does not remove properties from the actual object but rather relaxes the type requirements for parameters. Therefore, including image and image_webp should not pose a problem unless explicitly prohibited by TypeScript's checks.

Regarding the error at author: { ...author }, the issue lies with what User.findOneAndUpdate expects, not with your saveAuthor function. If the interface demands a full AuthorInterface, passing a partial one will result in errors.

If adapting the types required by User.findOneAndUpdate proves challenging, consider adjusting the code as suggested in Nancy's answer to accommodate the necessary flexibility.

Answer 8

When working on the saveAuthor function, it is important to note that only the author parameter is used for cloning and passing to User.findOneAndUpdate.

To clarify this further, you can define saveAuthor's parameter as:

author: Parameters<(typeof User)['findOneAndUpdate']>[1].author

This essentially means: "this function expects the same input as User.findOneAndUpdate."

A simpler approach would be to use the established type. Assuming that findOneAndUpdate requires an AuthorInterface in the 2nd parameter for the author property, you can simply write:

author: AuthorInterface

Furthermore, your concern about removing properties seems unnecessary:

"image and image_webp are image paths and therefore I cannot just override the values".

In the context of saveAuthor, you are not actually modifying these properties. The cloning operation using the spread operator { ...author } ensures that any modifications by User.findOneAndUpdate do not affect the original object.

Your confusion regarding types versus values is evident when referencing the Omit method. It does not remove properties from the actual object but rather relaxes the type requirements for parameters. Therefore, including image and image_webp should not pose a problem unless explicitly prohibited by TypeScript's checks.

Regarding the error at author: { ...author }, the issue lies with what User.findOneAndUpdate expects, not with your saveAuthor function. If the interface demands a full AuthorInterface, passing a partial one will result in errors.

If adapting the types required by User.findOneAndUpdate proves challenging, consider adjusting the code as suggested in Nancy's answer to accommodate the necessary flexibility.

Create allowances for specific areas

Answer №1

Answer №2

Answer №3

Answer №4

Similar questions

Develop an asynchronous thunk with TypeScript in Redux Toolkit, utilizing the features of rejectWithValue and Payload types for handling errors

Employ an asynchronous immediately-invoked function expression within the callback

Error in HTML: Text variable is not displaying the number value

What is the best way to retrieve the current URL with a hashtag symbol using JavaScript?

Issues with jQuery Ajax functionality in Rails application not achieving successful completion

React's componentWillMount() does not support the use of "if" statements

Error: Unable to locate module: Unable to resolve 'next/web-vitals'

Is it possible to apply action.payload to multiple keys within an object?

What is the most secure approach for defining the file path of an HTML file within an express.js application?

How to locate the index.js file within my application using Node.js?

Utilizing previously written HTML code snippets

Recursive routing in NodeJS using Express

Having trouble creating a PDF from HTML

Confirm that the dependency has been invoked using Sinon

Why does `react/require-default-props` still display an error even when a default prop value has been set?

Guide to sending both JSON data and form data in a single request using Laravel 9

Uncomplicating RxJs Operators: Decoding switchMap and combineLatest

How can nextJS leverage async getInitialProps() method in combination with AWS S3?

The @Input() function is failing to display or fetch the latest value that was passed

Tips for extracting the most deeply nested object in a JSON file using JavaScript