I'm looking to define a TypeScript Interface for objects similar to these:
{
"id": 34728,
"url": "https://example.com/image.jpg",
"commonNames": {
"de": ["Apfel", "Kulturapfel"],
"en": ["apple"],
"th": ["แอปเปิล"]
},
}
Am I on the right track with my method? I have some doubts, especially regarding the commonNames property.
interface Food {
id: number;
url: string;
commonNames: {
[index: string]: string[];
};
}
It has been confirmed in @Nicholas Tower's comment that your approach is correct.
There is a suggestion for a small improvement: instead of having three strings in your type definition, each representing different things, consider creating type aliases for better clarity:
type Uri = string;
type Language = string;
type Name = string;
interface Food {
id: number;
url: Uri;
commonNames: {
[index: Language]: Name[];
};
}
These aliases do not change the typing but enhance understanding of the attributes.
Additionally, using type aliases allows for attaching TSDoc comments for documentation purposes:
/**
/ * A globally unique, monotonically increasing identifier for a dictionary entry
**/
type Id = number;
/**
/ * A URI
**/
type Uri = string;
/**
/ * A URI referencing a picture of the food
**/
type PictureUri = Uri;
/**
/ * An ISO 639-1:2002 Alpha-2 Language Code
**/
type Language = string;
/**
/ * The name of the food
**/
type Name = string;
interface Food {
id: Id;
url: PictureUri;
commonNames: {
[index: Language]: Name[];
};
}
This example highlights the benefit of using type aliases for documentation.
Important Note: Although AWS SAM and DynamoDB are mentioned here, this question is primarily related to the AWS JavaScript SDK, or potentially just a Node/NPM query at its core. It should be answerable by anyone experienced in developing Node/JavaScript ap ...
I'm currently developing a function that writes JSON data to a file, and everything seems to be working well. However, despite specifying the output as UTF-8, Oxygen is having trouble reading pound and euro signs. Here's the Java code snippet: ...
I'm encountering an error despite having the NODE_ENV=development variable in my .env file. The error message reads: ● Test suite failed to run Config validation error: "NODE_ENV" must be one of [development, production] 11 | imports ...
As I work on implementing a guard for certain routes in my application, I face an issue. To grant access to the route, my intention is to send an HTTP request to my express backend API and check if the user's session exists. I have explored various e ...
Whenever I include with-tailwindcss at the end of the command line, it appears to cause an issue. Is there any solution for this? npx create-next-app -e with-tailwindcss project_name ...
I'm diving into Angular CLI for the first time and trying to recreate a previous web project of mine. I've managed to nest and display components inside the root component successfully, but after that, I'm facing issues referencing any compo ...
Currently, I've been working on a music bot using discord.js. To handle audio streaming, I'm utilizing @discordjs/opus and ytdl-core-discord. Everything runs smoothly when testing the bot locally on my machine - songs from YouTube are played with ...
Exploring the Implementation of Angular 6 Route Auth Guards Across Root and Child Routes ...
After following the steps outlined in the tutorial on connecting to wifi, I successfully linked my phone to my desktop wirelessly through the router. However, while I can test most applications wirelessly, I am encountering issues with those that require J ...
I've been testing out AppInsights and implementing the code below: (Encountering a 500 error on fetch) private callMethod(): void { this._callMethodInternal(); } private async _callMethodInternal(): Promise<void> { try { await fetch("h ...
As an experienced dog attempting to master new tricks like npm and TypeScript, I find myself faced with a challenge in my Visual Studio 2017 project. Despite setting it to "Latest" TypeScript 2.5 and adding @types/jquery (3.2.12), the project keeps throwin ...
I'm currently using Jhipster and have a function generated by Jhipster to open files in the browser. However, I'm facing an issue with this function when it comes to opening CSV files - instead of opening in the browser, they are being downloaded ...
I am currently filtering a group of objects in the following manner: [ { "Username":"00d9a7f4-0f0b-448b-91fc-fa5aef314d06", "Attributes":[ { "Name":"custom:organization", "Valu ...
I'm puzzled by the errors I'm encountering in my IDE with the following code: I defined some interfaces/types interfaces/types: interface GradientColor { type: string; value: { angle: string | number; colours: string[]; }; } inte ...
Is there a connection between the version of Typescript and the version of Node since Typescript is a global npm module? In other words, is there a minimum Node version required to run a specific version of Typescript. ...
I am struggling with the code below: export class FormComponent implements OnInit { name: string; empoloyeeID : number; empList: Array<{name: string, empoloyeeID: number}> = []; constructor() { } ngOnInit() { } onEmpCreate(){ conso ...
Seeking assistance with TypeORM and the @JoinTable and @RelationId Decorators. Any help answering my question, providing a hint, or ideally solving my issue would be greatly appreciated. I am utilizing NestJS with TypeORM to create a private API for shari ...
I am working on creating a dynamic class that can adapt its argument properties based on a certain value. To illustrate this concept, let's consider a simple example: Imagine I have a class called Customizer, and depending on the value of the mode pr ...
Currently, I have set up an API route within Next.js. Within the 'api' directory, my 'file.tsx' consists of the following code: import type { NextApiRequest, NextApiResponse } from "next"; const someFunction = (req: NextApiReq ...
I have come across the following code snippet: type DomainFieldDefinition<T> = { required?: boolean } type DomainDefinition<F, M> = { fields?: { [K in keyof F]: DomainFieldDefinition<F[K]> }, methods?: { [K in keyof M]: M[K] & ...