Sovereignty/jecs
1
0
Fork 0
mirror of https://github.com/Ukendio/jecs.git synced 2025-04-25 09:30:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update index.d.ts

Browse source 
doc comment on query:with
This commit is contained in:
EncodedVenom 2024-08-05 15:09:31 +01:00 committed by GitHub
parent 9b6f5e9fc3
commit 4b2af4812c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/index.d.ts vendored
View file

@ -8,6 +8,11 @@ type Query<T extends unknown[]> = {
* Resets the Iterator for a query. * Resets the Iterator for a query.
*/ */
drain: (this: Query<T>) => Query<T> drain: (this: Query<T>) => Query<T>
/**
* Modifies the query to include specified components, but will not include the values.
* @param components The components to include
* @returns Modified Query
*/
with: (this: Query<T>, ...components: Entity[]) => Query<T> with: (this: Query<T>, ...components: Entity[]) => Query<T>
/** /**
* Modifies the Query to exclude specified components * Modifies the Query to exclude specified components