Zadeklaruj i zainicjuj słownik w maszynopisie

248

Biorąc pod uwagę następujący kod

interface IPerson {
   firstName: string;
   lastName: string;
}

var persons: { [id: string]: IPerson; } = {
   "p1": { firstName: "F1", lastName: "L1" },
   "p2": { firstName: "F2" }
};

Dlaczego inicjalizacja nie jest odrzucana? W końcu drugi obiekt nie ma właściwości „lastName”.

mgs
źródło
11
Uwaga: od tego czasu zostało to naprawione (nie jestem pewien, która dokładnie wersja TS). Dostaję te błędy w VS, jak można się spodziewać: Index signatures are incompatible. Type '{ firstName: string; }' is not assignable to type 'IPerson'. Property 'lastName' is missing in type '{ firstName: string; }'.
Simon_Weaver

Odpowiedzi:

289

Edycja : Zostało to naprawione w najnowszych wersjach TS. Cytując komentarz @ Simon_Weavera do posta PO:

Uwaga: od tego czasu zostało to naprawione (nie jestem pewien, która dokładnie wersja TS). Otrzymuję te błędy w VS, jak można się spodziewać:Index signatures are incompatible. Type '{ firstName: string; }' is not assignable to type 'IPerson'. Property 'lastName' is missing in type '{ firstName: string; }'.


Najwyraźniej nie działa to przy przekazywaniu początkowych danych w deklaracji. Sądzę, że jest to błąd w TypeScript, więc powinieneś go zgłosić na stronie projektu.

Możesz skorzystać ze słownika maszynowego, dzieląc przykład na deklarację i inicjalizację, na przykład:

var persons: { [id: string] : IPerson; } = {};
persons["p1"] = { firstName: "F1", lastName: "L1" };
persons["p2"] = { firstName: "F2" }; // will result in an error
Thomaux
źródło
3
Dlaczego potrzebujesz tego idsymbolu? Wydaje się, że nie jest to konieczne.
kiewic
4
Za pomocą tego idsymbolu możesz zadeklarować, jaki powinien być typ kluczy słownika. W związku z powyższą deklaracją nie można wykonać następujących czynności:persons[1] = { firstName: 'F1', lastName: 'L1' }
thomaux
2
Zawsze zapomnij o tej składni z jakiegoś powodu!
eddiewould
12
idsymbol można nazwać coś cię jak zaprojektowana w taki sposób, aby ułatwić odczyt kodu. np. { [username: string] : IPerson; }
Guy Park,
1
@Robouste Chciałbym użyć metody findKey firmy Lodash , a jeśli wolisz rozwiązanie natywne, możesz zbudować na Object.entries . Jeśli chcesz uzyskać pełną listę kluczy, spójrz na Object.keys
thomaux
82

Aby użyć obiektu słownika w maszynopisie, możesz użyć interfejsu jak poniżej:

interface Dictionary<T> {
    [Key: string]: T;
}

i użyj tego dla swojego typu właściwości klasy.

export class SearchParameters {
    SearchFor: Dictionary<string> = {};
}

użyć i zainicjować tę klasę,

getUsers(): Observable<any> {
        var searchParams = new SearchParameters();
        searchParams.SearchFor['userId'] = '1';
        searchParams.SearchFor['userName'] = 'xyz';

        return this.http.post(searchParams, 'users/search')
            .map(res => {
                return res;
            })
            .catch(this.handleError.bind(this));
    }
Amol Bhor
źródło
61

Zgadzam się z Thomaux, że błąd sprawdzania typu inicjalizacji to błąd TypeScript. Nadal jednak chciałem znaleźć sposób na zadeklarowanie i zainicjowanie słownika w pojedynczej instrukcji z poprawnym sprawdzaniem typu. Ta implementacja jest dłuższa, ale dodaje dodatkowe funkcje, takie jak a containsKey(key: string)i remove(key: string)metoda. Podejrzewam, że można to uprościć, gdy leki generyczne będą dostępne w wersji 0.9.

Najpierw deklarujemy podstawową klasę Dictionary i interfejs. Interfejs jest wymagany dla modułu indeksującego, ponieważ klasy nie mogą ich zaimplementować.

interface IDictionary {
    add(key: string, value: any): void;
    remove(key: string): void;
    containsKey(key: string): bool;
    keys(): string[];
    values(): any[];
}

class Dictionary {

    _keys: string[] = new string[];
    _values: any[] = new any[];

    constructor(init: { key: string; value: any; }[]) {

        for (var x = 0; x < init.length; x++) {
            this[init[x].key] = init[x].value;
            this._keys.push(init[x].key);
            this._values.push(init[x].value);
        }
    }

    add(key: string, value: any) {
        this[key] = value;
        this._keys.push(key);
        this._values.push(value);
    }

    remove(key: string) {
        var index = this._keys.indexOf(key, 0);
        this._keys.splice(index, 1);
        this._values.splice(index, 1);

        delete this[key];
    }

    keys(): string[] {
        return this._keys;
    }

    values(): any[] {
        return this._values;
    }

    containsKey(key: string) {
        if (typeof this[key] === "undefined") {
            return false;
        }

        return true;
    }

    toLookup(): IDictionary {
        return this;
    }
}

Teraz deklarujemy typ osoby oraz interfejs Słownik / Słownik. W PersonDictionary zauważ, w jaki sposób zastępujemy values()i zwracamy toLookup()prawidłowe typy.

interface IPerson {
    firstName: string;
    lastName: string;
}

interface IPersonDictionary extends IDictionary {
    [index: string]: IPerson;
    values(): IPerson[];
}

class PersonDictionary extends Dictionary {
    constructor(init: { key: string; value: IPerson; }[]) {
        super(init);
    }

    values(): IPerson[]{
        return this._values;
    }

    toLookup(): IPersonDictionary {
        return this;
    }
}

A oto prosty przykład inicjalizacji i użycia:

var persons = new PersonDictionary([
    { key: "p1", value: { firstName: "F1", lastName: "L2" } },
    { key: "p2", value: { firstName: "F2", lastName: "L2" } },
    { key: "p3", value: { firstName: "F3", lastName: "L3" } }
]).toLookup();


alert(persons["p1"].firstName + " " + persons["p1"].lastName);
// alert: F1 L2

persons.remove("p2");

if (!persons.containsKey("p2")) {
    alert("Key no longer exists");
    // alert: Key no longer exists
}

alert(persons.keys().join(", "));
// alert: p1, p3
dmck
źródło
Bardzo pomocny przykładowy kod. „Interfejs IDictionary” zawiera małą literówkę, ponieważ istnieje odniesienie do IPerson.
mgs
fajnie byłoby również wprowadzić liczbę elementów
nurettin
@dmck Deklaracja containsKey(key: string): bool;nie działa z TypeScript 1.5.0-beta . Należy zmienić na containsKey(key: string): boolean;.
Amarjeet Singh,
1
dlaczego nie delcare typ ogólny? Słownik <T>, więc nie ma potrzeby tworzenia klasy PersonDictionary. Deklarujesz to w następujący sposób: var persons = new Dictionary <IPerson> ();
Benoit,
1
Użyłem takiego ogólnego słownika skutecznie. Znalazłem to tutaj: fabiolandoni.ch/…
CAK2
5

Oto bardziej ogólna implementacja słownika zainspirowana tym z @dmck

    interface IDictionary<T> {
      add(key: string, value: T): void;
      remove(key: string): void;
      containsKey(key: string): boolean;
      keys(): string[];
      values(): T[];
    }

    class Dictionary<T> implements IDictionary<T> {

      _keys: string[] = [];
      _values: T[] = [];

      constructor(init?: { key: string; value: T; }[]) {
        if (init) {
          for (var x = 0; x < init.length; x++) {
            this[init[x].key] = init[x].value;
            this._keys.push(init[x].key);
            this._values.push(init[x].value);
          }
        }
      }

      add(key: string, value: T) {
        this[key] = value;
        this._keys.push(key);
        this._values.push(value);
      }

      remove(key: string) {
        var index = this._keys.indexOf(key, 0);
        this._keys.splice(index, 1);
        this._values.splice(index, 1);

        delete this[key];
      }

      keys(): string[] {
        return this._keys;
      }

      values(): T[] {
        return this._values;
      }

      containsKey(key: string) {
        if (typeof this[key] === "undefined") {
          return false;
        }

        return true;
      }

      toLookup(): IDictionary<T> {
        return this;
      }
    }
mbcom
źródło
3

Jeśli chcesz zignorować właściwość, oznacz ją jako opcjonalną, dodając znak zapytania:

interface IPerson {
    firstName: string;
    lastName?: string;
}
Massimiliano Kraus
źródło
1
Cały problem polega na tym, dlaczego dany kod został skompilowany bez podania nazwiska…
Pierre Arlaud
-1

Teraz jest biblioteka, która zapewnia silnie typowane, kwerendowe kolekcje w maszynopisie.

Te kolekcje to:

  • Lista
  • Słownik

Biblioteka nazywa się ts-generic-collections-linq .

Kod źródłowy na GitHub:

https://github.com/VeritasSoftware/ts-generic-collections

NPM:

https://www.npmjs.com/package/ts-generic-collections-linq

Za pomocą tej biblioteki możesz tworzyć kolekcje (jak List<T>) i wyszukiwać je, jak pokazano poniżej.

    let owners = new List<Owner>();

    let owner = new Owner();
    owner.id = 1;
    owner.name = "John Doe";
    owners.add(owner);

    owner = new Owner();
    owner.id = 2;
    owner.name = "Jane Doe";
    owners.add(owner);    

    let pets = new List<Pet>();

    let pet = new Pet();
    pet.ownerId = 2;
    pet.name = "Sam";
    pet.sex = Sex.M;

    pets.add(pet);

    pet = new Pet();
    pet.ownerId = 1;
    pet.name = "Jenny";
    pet.sex = Sex.F;

    pets.add(pet);

    //query to get owners by the sex/gender of their pets
    let ownersByPetSex = owners.join(pets, owner => owner.id, pet => pet.ownerId, (x, y) => new OwnerPet(x,y))
                               .groupBy(x => [x.pet.sex])
                               .select(x =>  new OwnersByPetSex(x.groups[0], x.list.select(x => x.owner)));

    expect(ownersByPetSex.toArray().length === 2).toBeTruthy();

    expect(ownersByPetSex.toArray()[0].sex == Sex.F).toBeTruthy();
    expect(ownersByPetSex.toArray()[0].owners.length === 1).toBeTruthy();
    expect(ownersByPetSex.toArray()[0].owners.toArray()[0].name == "John Doe").toBeTruthy();

    expect(ownersByPetSex.toArray()[1].sex == Sex.M).toBeTruthy();
    expect(ownersByPetSex.toArray()[1].owners.length == 1).toBeTruthy();
    expect(ownersByPetSex.toArray()[1].owners.toArray()[0].name == "Jane Doe").toBeTruthy();
Jan
źródło
nie mogę znaleźć pakietu npm dla tego
Harry
1
@Harry - pakiet npm nazywa się „ts-generic-collections-linq”
Ade