Feature Request: Better typing for entity queries
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 38/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- typescript
- Ambito
- api
Direzione di ricerca
Inizia tracciando l’entry point Companies.getById, il tipo HubSpotEntity e la chiamata sottostante hubspot.crm.companies.basicApi.getById menzionata nell’issue. Definisci in che modo una selezione di proprietà readonly dovrebbe determinare le proprietà dell’entità restituita e considera la copertura esistente del controllo dei tipi; il lavoro è concluso quando le selezioni valide espongono le proprietà selezionate mentre i nomi non validi vengono rifiutati da TypeScript.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
It would be nice if we could have typed returns for entity queries.
const selection = ['name', 'jobtitle'] as const
const company = await Companies.getById<typeof selection>(id, selection)
/*
company.properties.name // OK
company.properties.jobtitle // OK
company.properties.joBTitle // ERROR
*/
Made a naive implementation for the above like this:
export const Companies = {
getById: async <Selection extends readonly string[]>(
id: string,
properties: Selection
): Promise<HubSpotEntity<Selection>> => {
const result = await hubspot.crm.companies.basicApi.getById(id, properties as any)
return result as HubSpotEntity<Selection>
}
};
- Lingua principale
- TypeScript
- Stelle
- 402
- Fork
- 116
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di HubSpot/hubspot-api-nodejs
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
HubSpot/hubspot-api-nodejs#684 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
HubSpot/hubspot-api-nodejs#696 · 1 commento ·
-
Difficoltà 3/5 3-5 giorni Idoneità per principianti 52/100
HubSpot/hubspot-api-nodejs#695 · 1 commento ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
HubSpot/hubspot-api-nodejs#691 · 4 commenti · 2 reazioni ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
HubSpot/hubspot-api-nodejs#690 · 2 reazioni ·
Tutte le issue di HubSpot/hubspot-api-nodejs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
rohitg00/agentmemory#1428 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
boxlite-ai/boxlite#1729 ·
I maintainer di solito rispondono entro 1 giorno
-
detectors enhancement good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
SM260845/readme-gen#1 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
angular/angularfire#3774 ·
I maintainer di solito rispondono entro 2 giorni